From 07926af177a43a848e830e509c21c036a21bac54 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 10 Mar 2026 07:24:02 +0000 Subject: [PATCH 01/31] chore: update docs/dyn/index.md --- docs/dyn/index.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/dyn/index.md b/docs/dyn/index.md index 27c0753eb2..0cba7c52da 100644 --- a/docs/dyn/index.md +++ b/docs/dyn/index.md @@ -518,6 +518,10 @@ * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/developerconnect_v1.html) +## developerknowledge +* [v1alpha](http://googleapis.github.io/google-api-python-client/docs/dyn/developerknowledge_v1alpha.html) + + ## dfareporting * [v3.5](http://googleapis.github.io/google-api-python-client/docs/dyn/dfareporting_v3_5.html) * [v4](http://googleapis.github.io/google-api-python-client/docs/dyn/dfareporting_v4.html) From 10d33297c93d17b03479d8ccd521167f6c2c2734 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 10 Mar 2026 07:24:02 +0000 Subject: [PATCH 02/31] feat(aiplatform): update the api #### aiplatform:v1 The following keys were deleted: - schemas.GoogleCloudAiplatformV1EvaluationInstance.properties.agentEvalData.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1EvaluationInstanceAgentConfig (Total Keys: 14) - schemas.GoogleCloudAiplatformV1EvaluationInstanceAgentData (Total Keys: 41) The following keys were added: - resources.projects.resources.locations.methods.askContexts (Total Keys: 12) - resources.projects.resources.locations.methods.asyncRetrieveContexts (Total Keys: 12) - resources.projects.resources.locations.resources.endpoints.resources.openapi.methods.responses (Total Keys: 14) - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments (Total Keys: 10) - schemas.CloudAiLargeModelsVisionGenerateVideoResponseVideo.properties.experimentsMetadata.$ref (Total Keys: 1) - schemas.CloudAiLargeModelsVisionHumanPose (Total Keys: 4) - schemas.CloudAiLargeModelsVisionPromptInputs (Total Keys: 8) - schemas.GoogleCloudAiplatformV1AskContextsRequest (Total Keys: 5) - schemas.GoogleCloudAiplatformV1AskContextsResponse (Total Keys: 4) - schemas.GoogleCloudAiplatformV1AsyncRetrieveContextsRequest (Total Keys: 5) - schemas.GoogleCloudAiplatformV1EmbedContentRequest.properties.autoTruncate.deprecated (Total Keys: 1) - schemas.GoogleCloudAiplatformV1EmbedContentRequest.properties.outputDimensionality.deprecated (Total Keys: 1) - schemas.GoogleCloudAiplatformV1EmbedContentRequest.properties.taskType.deprecated (Total Keys: 1) - schemas.GoogleCloudAiplatformV1EvaluateDatasetRun (Total Keys: 13) - schemas.GoogleCloudAiplatformV1EvaluationConfig (Total Keys: 7) - schemas.GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentConfig (Total Keys: 14) - schemas.GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentData (Total Keys: 41) - schemas.GoogleCloudAiplatformV1EventMetadata.properties.inputTranscription.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1EventMetadata.properties.outputTranscription.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1GroundingChunk.properties.image.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1GroundingChunkImage (Total Keys: 5) - schemas.GoogleCloudAiplatformV1GroundingChunkMaps.properties.route (Total Keys: 2) - schemas.GoogleCloudAiplatformV1GroundingChunkMapsRoute (Total Keys: 7) - schemas.GoogleCloudAiplatformV1GroundingMetadata.properties.imageSearchQueries (Total Keys: 2) - schemas.GoogleCloudAiplatformV1GroundingSupport.properties.renderedParts (Total Keys: 3) - schemas.GoogleCloudAiplatformV1ImageConfig.properties.prominentPeople.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1SupervisedTuningSpec.properties.evaluationConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1ToolGoogleSearch.properties.searchTypes.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1ToolGoogleSearchImageSearch (Total Keys: 2) - schemas.GoogleCloudAiplatformV1ToolGoogleSearchSearchTypes (Total Keys: 4) - schemas.GoogleCloudAiplatformV1ToolGoogleSearchWebSearch (Total Keys: 2) - schemas.GoogleCloudAiplatformV1Transcription (Total Keys: 4) - schemas.GoogleCloudAiplatformV1TuningJob.properties.evaluateDatasetRuns (Total Keys: 3) The following keys were changed: - schemas.GoogleCloudAiplatformV1EvaluationInstance.properties.agentData.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1GenerateInstanceRubricsRequest.properties.agentConfig.$ref (Total Keys: 1) #### aiplatform:v1beta1 The following keys were deleted: - schemas.GoogleCloudAiplatformV1beta1EvaluationInstanceAgentConfig (Total Keys: 14) - schemas.GoogleCloudAiplatformV1beta1EvaluationInstanceAgentData (Total Keys: 41) - schemas.GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfigAgentConfig (Total Keys: 5) The following keys were added: - resources.projects.resources.locations.methods.askContexts (Total Keys: 12) - resources.projects.resources.locations.methods.asyncRetrieveContexts (Total Keys: 12) - resources.projects.resources.locations.resources.endpoints.resources.openapi.methods.responses (Total Keys: 14) - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments (Total Keys: 10) - schemas.CloudAiLargeModelsVisionGenerateVideoResponseVideo.properties.experimentsMetadata.$ref (Total Keys: 1) - schemas.CloudAiLargeModelsVisionHumanPose (Total Keys: 4) - schemas.CloudAiLargeModelsVisionPromptInputs (Total Keys: 8) - schemas.GoogleCloudAiplatformV1beta1AskContextsRequest (Total Keys: 5) - schemas.GoogleCloudAiplatformV1beta1AskContextsResponse (Total Keys: 4) - schemas.GoogleCloudAiplatformV1beta1AsyncRetrieveContextsRequest (Total Keys: 5) - schemas.GoogleCloudAiplatformV1beta1DistillationSamplingSpec (Total Keys: 5) - schemas.GoogleCloudAiplatformV1beta1EmbedContentRequest.properties.autoTruncate.deprecated (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1EmbedContentRequest.properties.outputDimensionality.deprecated (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1EmbedContentRequest.properties.taskType.deprecated (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1EvaluateDatasetRun.properties.operationName.deprecated (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentConfig (Total Keys: 14) - schemas.GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentData (Total Keys: 41) - schemas.GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfigInferenceAgentConfig (Total Keys: 5) - schemas.GoogleCloudAiplatformV1beta1EventMetadata.properties.inputTranscription.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1EventMetadata.properties.outputTranscription.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1GroundingChunk.properties.image.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1GroundingChunkImage (Total Keys: 5) - schemas.GoogleCloudAiplatformV1beta1GroundingChunkMaps.properties.route (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1GroundingChunkMapsRoute (Total Keys: 7) - schemas.GoogleCloudAiplatformV1beta1GroundingMetadata.properties.imageSearchQueries (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1GroundingSupport.properties.renderedParts (Total Keys: 3) - schemas.GoogleCloudAiplatformV1beta1ImageConfig.properties.prominentPeople.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1ImportRagFilesConfig.properties.ragFileMetadataConfig.deprecated (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1ToolGoogleSearch.properties.searchTypes.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1ToolGoogleSearchImageSearch (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1ToolGoogleSearchSearchTypes (Total Keys: 4) - schemas.GoogleCloudAiplatformV1beta1ToolGoogleSearchWebSearch (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1Transcription (Total Keys: 4) - schemas.GoogleCloudAiplatformV1beta1TuningJob.properties.distillationSamplingSpec.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1TuningJob.properties.tuningJobMetadata (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1TuningJobMetadata (Total Keys: 8) - schemas.GoogleCloudAiplatformV1beta1UploadRagFileConfig.properties.ragFileMetadataConfig.deprecated (Total Keys: 1) The following keys were changed: - schemas.GoogleCloudAiplatformV1beta1EvaluationInstance.properties.agentData.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1EvaluationInstance.properties.agentEvalData.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfig.properties.agentConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1GenerateInstanceRubricsRequest.properties.agentConfig.$ref (Total Keys: 1) --- docs/dyn/aiplatform_v1.endpoints.html | 77 +- ..._v1.projects.locations.cachedContents.html | 60 +- ...tform_v1.projects.locations.endpoints.html | 77 +- ....projects.locations.endpoints.openapi.html | 42 + ..._v1.projects.locations.evaluationRuns.html | 108 +- .../dyn/aiplatform_v1.projects.locations.html | 2241 ++++-------- ....projects.locations.publishers.models.html | 89 +- ...ions.reasoningEngines.sessions.events.html | 27 +- ...s.locations.reasoningEngines.sessions.html | 27 +- ...form_v1.projects.locations.tuningJobs.html | 3237 ++++++++++++++++- docs/dyn/aiplatform_v1.publishers.models.html | 77 +- docs/dyn/aiplatform_v1.v1.html | 1356 +------ docs/dyn/aiplatform_v1beta1.endpoints.html | 77 +- docs/dyn/aiplatform_v1beta1.media.html | 2 +- ...ta1.projects.locations.cachedContents.html | 60 +- ...m_v1beta1.projects.locations.datasets.html | 26 +- ..._v1beta1.projects.locations.endpoints.html | 77 +- ....projects.locations.endpoints.openapi.html | 42 + ...a1.projects.locations.evaluationItems.html | 480 ++- ...ta1.projects.locations.evaluationRuns.html | 148 +- ...v1beta1.projects.locations.extensions.html | 20 +- ...aiplatform_v1beta1.projects.locations.html | 1983 +++++----- ....projects.locations.publishers.models.html | 89 +- ...rojects.locations.ragCorpora.ragFiles.html | 2 +- ...ions.reasoningEngines.sessions.events.html | 27 +- ...s.locations.reasoningEngines.sessions.html | 27 +- ...v1beta1.projects.locations.tuningJobs.html | 115 +- .../aiplatform_v1beta1.publishers.models.html | 77 +- ...eta1.reasoningEngines.sessions.events.html | 27 +- ...orm_v1beta1.reasoningEngines.sessions.html | 27 +- docs/dyn/aiplatform_v1beta1.v1beta1.html | 1178 ++---- .../documents/aiplatform.v1.json | 513 ++- .../documents/aiplatform.v1beta1.json | 502 ++- 33 files changed, 7623 insertions(+), 5294 deletions(-) diff --git a/docs/dyn/aiplatform_v1.endpoints.html b/docs/dyn/aiplatform_v1.endpoints.html index c270881c10..ab1b14a267 100644 --- a/docs/dyn/aiplatform_v1.endpoints.html +++ b/docs/dyn/aiplatform_v1.endpoints.html @@ -328,6 +328,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -348,7 +349,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -534,7 +535,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -574,7 +575,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -615,6 +616,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -879,6 +886,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -899,7 +907,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1111,7 +1119,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1151,7 +1159,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1192,6 +1200,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -1402,6 +1416,12 @@

Method Details

"googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps. { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information. + "image": { # An `Image` chunk is a piece of evidence that comes from an image search result. It contains the URI of the image search result and the URI of the image. This is used to provide the user with a link to the source of the information. # A grounding chunk from an image search result. See the `Image` message for details. + "domain": "A String", # The domain of the image search result page. + "imageUri": "A String", # The URI of the image. + "sourceUri": "A String", # The URI of the image search result page. + "title": "A String", # The title of the image search result page. + }, "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps, containing information about places or routes. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details. "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. "reviewSnippets": [ # Snippets of reviews that were used to generate the answer. @@ -1413,6 +1433,11 @@

Method Details

], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API. + "route": { # Route information from Google Maps. # Output only. Route information. + "distanceMeters": 42, # The total distance of the route, in meters. + "duration": "A String", # The total duration of the route. + "encodedPolyline": "A String", # An encoded polyline of the route. See https://developers.google.com/maps/documentation/utilities/polylinealgorithm + }, "text": "A String", # The text of the place answer. "title": "A String", # The title of the place. "uri": "A String", # The URI of the place. @@ -1438,13 +1463,16 @@

Method Details

}, ], "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search. - { # A collection of supporting references for a segment of the model's response. + { # A collection of supporting references for a segment or part of the model's response. "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored. 3.14, ], "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment. 42, ], + "renderedParts": [ # Indices into the `rendered_parts` field of the `GroundingMetadata` message. These indices specify which rendered parts are associated with this support message. + 42, + ], "segment": { # A segment of the content. # The content segment that this support message applies to. "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index. "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content. @@ -1453,6 +1481,9 @@

Method Details

}, }, ], + "imageSearchQueries": [ # Optional. The image search queries that were used to generate the content. This field is populated only when the grounding source is Google Search with the Image Search search_type enabled. + "A String", + ], "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, @@ -1750,6 +1781,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -1770,7 +1802,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1982,7 +2014,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2022,7 +2054,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2063,6 +2095,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -2273,6 +2311,12 @@

Method Details

"googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps. { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information. + "image": { # An `Image` chunk is a piece of evidence that comes from an image search result. It contains the URI of the image search result and the URI of the image. This is used to provide the user with a link to the source of the information. # A grounding chunk from an image search result. See the `Image` message for details. + "domain": "A String", # The domain of the image search result page. + "imageUri": "A String", # The URI of the image. + "sourceUri": "A String", # The URI of the image search result page. + "title": "A String", # The title of the image search result page. + }, "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps, containing information about places or routes. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details. "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. "reviewSnippets": [ # Snippets of reviews that were used to generate the answer. @@ -2284,6 +2328,11 @@

Method Details

], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API. + "route": { # Route information from Google Maps. # Output only. Route information. + "distanceMeters": 42, # The total distance of the route, in meters. + "duration": "A String", # The total duration of the route. + "encodedPolyline": "A String", # An encoded polyline of the route. See https://developers.google.com/maps/documentation/utilities/polylinealgorithm + }, "text": "A String", # The text of the place answer. "title": "A String", # The title of the place. "uri": "A String", # The URI of the place. @@ -2309,13 +2358,16 @@

Method Details

}, ], "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search. - { # A collection of supporting references for a segment of the model's response. + { # A collection of supporting references for a segment or part of the model's response. "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored. 3.14, ], "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment. 42, ], + "renderedParts": [ # Indices into the `rendered_parts` field of the `GroundingMetadata` message. These indices specify which rendered parts are associated with this support message. + 42, + ], "segment": { # A segment of the content. # The content segment that this support message applies to. "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index. "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content. @@ -2324,6 +2376,9 @@

Method Details

}, }, ], + "imageSearchQueries": [ # Optional. The image search queries that were used to generate the content. This field is populated only when the grounding source is Google Search with the Image Search search_type enabled. + "A String", + ], "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, diff --git a/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html index b129084fc1..ebdc1bfa66 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html +++ b/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html @@ -314,7 +314,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -354,7 +354,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -395,6 +395,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -718,7 +724,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -758,7 +764,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -799,6 +805,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -1147,7 +1159,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1187,7 +1199,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1228,6 +1240,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -1562,7 +1580,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1602,7 +1620,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1643,6 +1661,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -1985,7 +2009,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2025,7 +2049,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2066,6 +2090,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -2390,7 +2420,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2430,7 +2460,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2471,6 +2501,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html index ac8fa0cfe7..815b2b2a12 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html @@ -396,6 +396,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -416,7 +417,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -602,7 +603,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -642,7 +643,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -683,6 +684,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -1843,6 +1850,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -1863,7 +1871,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2075,7 +2083,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2115,7 +2123,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2156,6 +2164,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -2366,6 +2380,12 @@

Method Details

"googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps. { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information. + "image": { # An `Image` chunk is a piece of evidence that comes from an image search result. It contains the URI of the image search result and the URI of the image. This is used to provide the user with a link to the source of the information. # A grounding chunk from an image search result. See the `Image` message for details. + "domain": "A String", # The domain of the image search result page. + "imageUri": "A String", # The URI of the image. + "sourceUri": "A String", # The URI of the image search result page. + "title": "A String", # The title of the image search result page. + }, "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps, containing information about places or routes. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details. "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. "reviewSnippets": [ # Snippets of reviews that were used to generate the answer. @@ -2377,6 +2397,11 @@

Method Details

], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API. + "route": { # Route information from Google Maps. # Output only. Route information. + "distanceMeters": 42, # The total distance of the route, in meters. + "duration": "A String", # The total duration of the route. + "encodedPolyline": "A String", # An encoded polyline of the route. See https://developers.google.com/maps/documentation/utilities/polylinealgorithm + }, "text": "A String", # The text of the place answer. "title": "A String", # The title of the place. "uri": "A String", # The URI of the place. @@ -2402,13 +2427,16 @@

Method Details

}, ], "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search. - { # A collection of supporting references for a segment of the model's response. + { # A collection of supporting references for a segment or part of the model's response. "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored. 3.14, ], "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment. 42, ], + "renderedParts": [ # Indices into the `rendered_parts` field of the `GroundingMetadata` message. These indices specify which rendered parts are associated with this support message. + 42, + ], "segment": { # A segment of the content. # The content segment that this support message applies to. "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index. "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content. @@ -2417,6 +2445,9 @@

Method Details

}, }, ], + "imageSearchQueries": [ # Optional. The image search queries that were used to generate the content. This field is populated only when the grounding source is Google Search with the Image Search search_type enabled. + "A String", + ], "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, @@ -4196,6 +4227,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -4216,7 +4248,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -4428,7 +4460,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -4468,7 +4500,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -4509,6 +4541,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -4719,6 +4757,12 @@

Method Details

"googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps. { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information. + "image": { # An `Image` chunk is a piece of evidence that comes from an image search result. It contains the URI of the image search result and the URI of the image. This is used to provide the user with a link to the source of the information. # A grounding chunk from an image search result. See the `Image` message for details. + "domain": "A String", # The domain of the image search result page. + "imageUri": "A String", # The URI of the image. + "sourceUri": "A String", # The URI of the image search result page. + "title": "A String", # The title of the image search result page. + }, "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps, containing information about places or routes. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details. "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. "reviewSnippets": [ # Snippets of reviews that were used to generate the answer. @@ -4730,6 +4774,11 @@

Method Details

], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API. + "route": { # Route information from Google Maps. # Output only. Route information. + "distanceMeters": 42, # The total distance of the route, in meters. + "duration": "A String", # The total duration of the route. + "encodedPolyline": "A String", # An encoded polyline of the route. See https://developers.google.com/maps/documentation/utilities/polylinealgorithm + }, "text": "A String", # The text of the place answer. "title": "A String", # The title of the place. "uri": "A String", # The URI of the place. @@ -4755,13 +4804,16 @@

Method Details

}, ], "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search. - { # A collection of supporting references for a segment of the model's response. + { # A collection of supporting references for a segment or part of the model's response. "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored. 3.14, ], "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment. 42, ], + "renderedParts": [ # Indices into the `rendered_parts` field of the `GroundingMetadata` message. These indices specify which rendered parts are associated with this support message. + 42, + ], "segment": { # A segment of the content. # The content segment that this support message applies to. "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index. "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content. @@ -4770,6 +4822,9 @@

Method Details

}, }, ], + "imageSearchQueries": [ # Optional. The image search queries that were used to generate the content. This field is populated only when the grounding source is Google Search with the Image Search search_type enabled. + "A String", + ], "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.openapi.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.openapi.html index e139657d2a..9749856017 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.endpoints.openapi.html +++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.openapi.html @@ -83,6 +83,9 @@

Instance Methods

embeddings(endpoint, body=None, deployedModelId=None, x__xgafv=None)

Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.

+

+ responses(endpoint, body=None, deployedModelId=None, x__xgafv=None)

+

Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.

Method Details

close() @@ -167,4 +170,43 @@

Method Details

}
+
+ responses(endpoint, body=None, deployedModelId=None, x__xgafv=None) +
Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.
+
+Args:
+  endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+  deployedModelId: string, ID of the DeployedModel that serves the invoke request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html b/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html index 90b07b3f98..91a8d1d5c5 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html +++ b/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html @@ -179,6 +179,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -199,7 +200,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -307,6 +308,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -327,7 +329,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -431,6 +433,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -451,7 +454,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -580,6 +583,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -600,7 +604,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -705,6 +709,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -725,7 +730,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -879,6 +884,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -899,7 +905,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -997,6 +1003,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -1017,7 +1024,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1144,6 +1151,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -1164,7 +1172,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1281,6 +1289,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -1301,7 +1310,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1444,6 +1453,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -1464,7 +1474,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1572,6 +1582,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -1592,7 +1603,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1696,6 +1707,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -1716,7 +1728,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1845,6 +1857,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -1865,7 +1878,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1970,6 +1983,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -1990,7 +2004,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2144,6 +2158,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -2164,7 +2179,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2262,6 +2277,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -2282,7 +2298,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2409,6 +2425,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -2429,7 +2446,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2546,6 +2563,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -2566,7 +2584,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2751,6 +2769,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -2771,7 +2790,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2879,6 +2898,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -2899,7 +2919,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -3003,6 +3023,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -3023,7 +3044,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -3152,6 +3173,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -3172,7 +3194,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -3277,6 +3299,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -3297,7 +3320,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -3451,6 +3474,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -3471,7 +3495,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -3569,6 +3593,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -3589,7 +3614,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -3716,6 +3741,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -3736,7 +3762,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -3853,6 +3879,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -3873,7 +3900,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -4029,6 +4056,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -4049,7 +4077,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -4157,6 +4185,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -4177,7 +4206,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -4281,6 +4310,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -4301,7 +4331,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -4430,6 +4460,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -4450,7 +4481,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -4555,6 +4586,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -4575,7 +4607,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -4729,6 +4761,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -4749,7 +4782,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -4847,6 +4880,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -4867,7 +4901,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -4994,6 +5028,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -5014,7 +5049,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -5131,6 +5166,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -5151,7 +5187,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], diff --git a/docs/dyn/aiplatform_v1.projects.locations.html b/docs/dyn/aiplatform_v1.projects.locations.html index 6f7bd543ae..d4df06652c 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.html @@ -259,6 +259,12 @@

Instance Methods

Returns the tuningJobs Resource.

+

+ askContexts(parent, body=None, x__xgafv=None)

+

Agentic Retrieval Ask API for RAG.

+

+ asyncRetrieveContexts(parent, body=None, x__xgafv=None)

+

Asynchronous API to retrieves relevant contexts for a query.

augmentPrompt(parent, body=None, x__xgafv=None)

Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses.

@@ -302,6 +308,559 @@

Instance Methods

updateRagEngineConfig(name, body=None, x__xgafv=None)

Updates a RagEngineConfig.

Method Details

+
+ askContexts(parent, body=None, x__xgafv=None) +
Agentic Retrieval Ask API for RAG.
+
+Args:
+  parent: string, Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Agentic Retrieval Ask API for RAG. Request message for VertexRagService.AskContexts.
+  "query": { # A query to retrieve relevant contexts. # Required. Single RAG retrieve query.
+    "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the query.
+      "filter": { # Config for filters. # Optional. Config for filters.
+        "metadataFilter": "A String", # Optional. String for metadata filtering.
+        "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold.
+        "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold.
+      },
+      "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking.
+        "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker.
+          "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+        },
+        "rankService": { # Config for Rank Service. # Optional. Config for Rank Service.
+          "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest`
+        },
+      },
+      "topK": 42, # Optional. The number of contexts to retrieve.
+    },
+    "text": "A String", # Optional. The query in text format to get relevant contexts.
+  },
+  "tools": [ # Optional. The tools to use for AskContexts.
+    { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
+      "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
+      },
+      "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations.
+        "environment": "A String", # Required. The environment being operated.
+        "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions.
+          "A String",
+        ],
+      },
+      "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+        "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
+        "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
+          "A String",
+        ],
+      },
+      "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided.
+        { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client.
+          "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.
+          "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64.
+          "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1
+            "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
+            "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.
+              # Object with schema name: GoogleCloudAiplatformV1Schema
+            ],
+            "default": "", # Optional. Default value to use if the field is not specified.
+            "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
+              "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+            },
+            "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
+            "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
+              "A String",
+            ],
+            "example": "", # Optional. Example of an instance of this schema.
+            "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.
+            "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.
+            "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.
+            "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.
+            "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.
+            "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.
+            "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.
+            "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.
+            "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.
+            "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.
+            "nullable": True or False, # Optional. Indicates if the value of this field can be null.
+            "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.
+            "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.
+              "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+            },
+            "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.
+              "A String",
+            ],
+            "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+            "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.
+              "A String",
+            ],
+            "title": "A String", # Optional. Title for the schema.
+            "type": "A String", # Optional. Data type of the schema field.
+          },
+          "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`.
+          "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function.
+            "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
+            "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.
+              # Object with schema name: GoogleCloudAiplatformV1Schema
+            ],
+            "default": "", # Optional. Default value to use if the field is not specified.
+            "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
+              "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+            },
+            "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
+            "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
+              "A String",
+            ],
+            "example": "", # Optional. Example of an instance of this schema.
+            "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.
+            "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.
+            "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.
+            "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.
+            "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.
+            "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.
+            "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.
+            "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.
+            "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.
+            "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.
+            "nullable": True or False, # Optional. Indicates if the value of this field can be null.
+            "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.
+            "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.
+              "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+            },
+            "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.
+              "A String",
+            ],
+            "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+            "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.
+              "A String",
+            ],
+            "title": "A String", # Optional. Title for the schema.
+            "type": "A String", # Optional. Data type of the schema field.
+          },
+          "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`.
+        },
+      ],
+      "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model.
+        "enableWidget": True or False, # Optional. If true, include the widget context token in the response.
+      },
+      "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+        "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
+        "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
+          "A String",
+        ],
+        "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default.
+          "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned.
+          },
+          "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned.
+          },
+        },
+      },
+      "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search.
+        "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
+          "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
+          "mode": "A String", # The mode of the predictor to be used in dynamic retrieval.
+        },
+      },
+      "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation
+        "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details.
+        "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } }
+          "a_key": "", # Properties of the object.
+        },
+      },
+      "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
+        "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
+        "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding.
+          "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead.
+            "apiKeyConfig": { # The API secret. # The API secret.
+              "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
+              "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set.
+            },
+          },
+          "apiSpec": "A String", # The API spec that the external API implements.
+          "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API.
+            "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth.
+              "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource.
+              "apiKeyString": "A String", # Optional. The API key to be used in the request directly.
+              "httpElementLocation": "A String", # Optional. The location of the API key.
+              "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name.
+            },
+            "authType": "A String", # Type of auth scheme.
+            "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth.
+              "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension.
+            },
+            "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth.
+              "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource.
+            },
+            "oauthConfig": { # Config for user oauth. # Config for user oauth.
+              "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
+              "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account.
+            },
+            "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth.
+              "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
+              "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).
+            },
+          },
+          "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API.
+            "index": "A String", # The ElasticSearch index to use.
+            "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param.
+            "searchTemplate": "A String", # The ElasticSearch search template to use.
+          },
+          "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search
+          "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API.
+          },
+        },
+        "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
+          "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
+            { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec
+              "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
+              "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+            },
+          ],
+          "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
+          "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+          "filter": "A String", # Optional. Filter strings to be passed to the search API.
+          "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
+        },
+        "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
+          "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.
+            { # The definition of the Rag resource.
+              "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
+              "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field.
+                "A String",
+              ],
+            },
+          ],
+          "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query.
+            "filter": { # Config for filters. # Optional. Config for filters.
+              "metadataFilter": "A String", # Optional. String for metadata filtering.
+              "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold.
+              "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold.
+            },
+            "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking.
+              "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker.
+                "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+              },
+              "rankService": { # Config for Rank Service. # Optional. Config for Rank Service.
+                "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest`
+              },
+            },
+            "topK": 42, # Optional. The number of contexts to retrieve.
+          },
+          "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora.
+          "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold.
+        },
+      },
+      "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval.
+      },
+    },
+  ],
+}
+
+  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 VertexRagService.AskContexts.
+  "contexts": { # Relevant contexts for one query. # The contexts of the query.
+    "contexts": [ # All its contexts.
+      { # A context of the query.
+        "chunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Context of the retrieved chunk.
+          "pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document.
+            "firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed.
+            "lastPage": 42, # Page where chunk ends in the document. Inclusive. 1-indexed.
+          },
+          "text": "A String", # The content of the chunk.
+        },
+        "score": 3.14, # According to the underlying Vector DB and the selected metric type, the score can be either the distance or the similarity between the query and the context and its range depends on the metric type. For example, if the metric type is COSINE_DISTANCE, it represents the distance between the query and the context. The larger the distance, the less relevant the context is to the query. The range is [0, 2], while 0 means the most relevant and 2 means the least relevant.
+        "sourceDisplayName": "A String", # The file display name.
+        "sourceUri": "A String", # If the file is imported from Cloud Storage or Google Drive, source_uri will be original file URI in Cloud Storage or Google Drive; if file is uploaded, source_uri will be file display name.
+        "text": "A String", # The text chunk.
+      },
+    ],
+  },
+  "response": "A String", # The Retrieval Response.
+}
+
+ +
+ asyncRetrieveContexts(parent, body=None, x__xgafv=None) +
Asynchronous API to retrieves relevant contexts for a query.
+
+Args:
+  parent: string, Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for VertexRagService.AsyncRetrieveContexts.
+  "query": { # A query to retrieve relevant contexts. # Required. Single RAG retrieve query.
+    "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the query.
+      "filter": { # Config for filters. # Optional. Config for filters.
+        "metadataFilter": "A String", # Optional. String for metadata filtering.
+        "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold.
+        "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold.
+      },
+      "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking.
+        "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker.
+          "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+        },
+        "rankService": { # Config for Rank Service. # Optional. Config for Rank Service.
+          "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest`
+        },
+      },
+      "topK": 42, # Optional. The number of contexts to retrieve.
+    },
+    "text": "A String", # Optional. The query in text format to get relevant contexts.
+  },
+  "tools": [ # Optional. The tools to use for AskContexts.
+    { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
+      "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
+      },
+      "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations.
+        "environment": "A String", # Required. The environment being operated.
+        "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions.
+          "A String",
+        ],
+      },
+      "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+        "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
+        "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
+          "A String",
+        ],
+      },
+      "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided.
+        { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client.
+          "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.
+          "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64.
+          "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1
+            "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
+            "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.
+              # Object with schema name: GoogleCloudAiplatformV1Schema
+            ],
+            "default": "", # Optional. Default value to use if the field is not specified.
+            "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
+              "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+            },
+            "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
+            "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
+              "A String",
+            ],
+            "example": "", # Optional. Example of an instance of this schema.
+            "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.
+            "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.
+            "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.
+            "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.
+            "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.
+            "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.
+            "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.
+            "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.
+            "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.
+            "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.
+            "nullable": True or False, # Optional. Indicates if the value of this field can be null.
+            "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.
+            "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.
+              "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+            },
+            "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.
+              "A String",
+            ],
+            "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+            "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.
+              "A String",
+            ],
+            "title": "A String", # Optional. Title for the schema.
+            "type": "A String", # Optional. Data type of the schema field.
+          },
+          "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`.
+          "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function.
+            "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
+            "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.
+              # Object with schema name: GoogleCloudAiplatformV1Schema
+            ],
+            "default": "", # Optional. Default value to use if the field is not specified.
+            "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
+              "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+            },
+            "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
+            "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
+              "A String",
+            ],
+            "example": "", # Optional. Example of an instance of this schema.
+            "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.
+            "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.
+            "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.
+            "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.
+            "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.
+            "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.
+            "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.
+            "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.
+            "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.
+            "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.
+            "nullable": True or False, # Optional. Indicates if the value of this field can be null.
+            "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.
+            "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.
+              "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+            },
+            "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.
+              "A String",
+            ],
+            "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+            "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.
+              "A String",
+            ],
+            "title": "A String", # Optional. Title for the schema.
+            "type": "A String", # Optional. Data type of the schema field.
+          },
+          "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`.
+        },
+      ],
+      "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model.
+        "enableWidget": True or False, # Optional. If true, include the widget context token in the response.
+      },
+      "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+        "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
+        "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
+          "A String",
+        ],
+        "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default.
+          "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned.
+          },
+          "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned.
+          },
+        },
+      },
+      "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search.
+        "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
+          "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
+          "mode": "A String", # The mode of the predictor to be used in dynamic retrieval.
+        },
+      },
+      "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation
+        "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details.
+        "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } }
+          "a_key": "", # Properties of the object.
+        },
+      },
+      "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
+        "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
+        "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding.
+          "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead.
+            "apiKeyConfig": { # The API secret. # The API secret.
+              "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
+              "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set.
+            },
+          },
+          "apiSpec": "A String", # The API spec that the external API implements.
+          "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API.
+            "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth.
+              "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource.
+              "apiKeyString": "A String", # Optional. The API key to be used in the request directly.
+              "httpElementLocation": "A String", # Optional. The location of the API key.
+              "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name.
+            },
+            "authType": "A String", # Type of auth scheme.
+            "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth.
+              "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension.
+            },
+            "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth.
+              "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource.
+            },
+            "oauthConfig": { # Config for user oauth. # Config for user oauth.
+              "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
+              "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account.
+            },
+            "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth.
+              "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
+              "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).
+            },
+          },
+          "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API.
+            "index": "A String", # The ElasticSearch index to use.
+            "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param.
+            "searchTemplate": "A String", # The ElasticSearch search template to use.
+          },
+          "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search
+          "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API.
+          },
+        },
+        "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
+          "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
+            { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec
+              "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
+              "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+            },
+          ],
+          "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
+          "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+          "filter": "A String", # Optional. Filter strings to be passed to the search API.
+          "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
+        },
+        "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
+          "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.
+            { # The definition of the Rag resource.
+              "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
+              "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field.
+                "A String",
+              ],
+            },
+          ],
+          "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query.
+            "filter": { # Config for filters. # Optional. Config for filters.
+              "metadataFilter": "A String", # Optional. String for metadata filtering.
+              "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold.
+              "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold.
+            },
+            "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking.
+              "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker.
+                "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+              },
+              "rankService": { # Config for Rank Service. # Optional. Config for Rank Service.
+                "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest`
+              },
+            },
+            "topK": 42, # Optional. The number of contexts to retrieve.
+          },
+          "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora.
+          "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold.
+        },
+      },
+      "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval.
+      },
+    },
+  ],
+}
+
+  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.
+  },
+}
+
+
augmentPrompt(parent, body=None, x__xgafv=None)
Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses.
@@ -921,6 +1480,7 @@ 

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -941,7 +1501,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1072,6 +1632,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -1092,7 +1653,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1197,6 +1758,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -1217,7 +1779,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1398,1456 +1960,178 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, - "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. - "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. - "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. - "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. - "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. - "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. - "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. - "A String", - ], - "responseSchema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. - "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. - "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. - # Object with schema name: GoogleCloudAiplatformV1Schema - ], - "default": "", # Optional. Default value to use if the field is not specified. - "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. - "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema - }, - "description": "A String", # Optional. Description of the schema. - "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` - "A String", - ], - "example": "", # Optional. Example of an instance of this schema. - "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. - "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. - "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. - "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. - "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. - "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. - "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. - "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. - "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. - "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. - "nullable": True or False, # Optional. Indicates if the value of this field can be null. - "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. - "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. - "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema - }, - "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. - "A String", - ], - "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring - "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. - "A String", - ], - "title": "A String", # Optional. Title for the schema. - "type": "A String", # Optional. Data type of the schema field. - }, - "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. - "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. - "modelRoutingPreference": "A String", # The model routing preference. - }, - "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. - "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. - }, - }, - "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. - "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. - "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech 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": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. - "voiceName": "A String", # The name of the prebuilt voice to use. - }, - "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. - "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. - "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. - }, - }, - }, - ], - }, - "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. - "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. - "voiceName": "A String", # The name of the prebuilt voice to use. - }, - "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. - "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. - "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. - }, - }, - }, - "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. - "A String", - ], - "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. - "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. - "thinkingLevel": "A String", # Optional. The number of thoughts tokens that the model should generate. - }, - "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. - "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. - }, - "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. - }, - "bleuInput": { # Input for bleu metric. # Instances and metric spec for bleu metric. - "instances": [ # Required. Repeated bleu instances. - { # Spec for bleu instance. - "prediction": "A String", # Required. Output of the evaluated model. - "reference": "A String", # Required. Ground truth used to compare against the prediction. - }, - ], - "metricSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Required. Spec for bleu score metric. - "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score. - }, - }, - "coherenceInput": { # Input for coherence metric. # Input for coherence metric. - "instance": { # Spec for coherence instance. # Required. Coherence instance. - "prediction": "A String", # Required. Output of the evaluated model. - }, - "metricSpec": { # Spec for coherence score metric. # Required. Spec for coherence score metric. - "version": 42, # Optional. Which version to use for evaluation. - }, - }, - "cometInput": { # Input for Comet metric. # Translation metrics. Input for Comet metric. - "instance": { # Spec for Comet instance - The fields used for evaluation are dependent on the comet version. # Required. Comet instance. - "prediction": "A String", # Required. Output of the evaluated model. - "reference": "A String", # Optional. Ground truth used to compare against the prediction. - "source": "A String", # Optional. Source text in original language. - }, - "metricSpec": { # Spec for Comet metric. # Required. Spec for comet metric. - "sourceLanguage": "A String", # Optional. Source language in BCP-47 format. - "targetLanguage": "A String", # Optional. Target language in BCP-47 format. Covers both prediction and reference. - "version": "A String", # Required. Which version to use for evaluation. - }, - }, - "exactMatchInput": { # Input for exact match metric. # Auto metric instances. Instances and metric spec for exact match metric. - "instances": [ # Required. Repeated exact match instances. - { # Spec for exact match instance. - "prediction": "A String", # Required. Output of the evaluated model. - "reference": "A String", # Required. Ground truth used to compare against the prediction. - }, - ], - "metricSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Required. Spec for exact match metric. - }, - }, - "fluencyInput": { # Input for fluency metric. # LLM-based metric instance. General text generation metrics, applicable to other categories. Input for fluency metric. - "instance": { # Spec for fluency instance. # Required. Fluency instance. - "prediction": "A String", # Required. Output of the evaluated model. - }, - "metricSpec": { # Spec for fluency score metric. # Required. Spec for fluency score metric. - "version": 42, # Optional. Which version to use for evaluation. - }, - }, - "fulfillmentInput": { # Input for fulfillment metric. # Input for fulfillment metric. - "instance": { # Spec for fulfillment instance. # Required. Fulfillment instance. - "instruction": "A String", # Required. Inference instruction prompt to compare prediction with. - "prediction": "A String", # Required. Output of the evaluated model. - }, - "metricSpec": { # Spec for fulfillment metric. # Required. Spec for fulfillment score metric. - "version": 42, # Optional. Which version to use for evaluation. - }, - }, - "groundednessInput": { # Input for groundedness metric. # Input for groundedness metric. - "instance": { # Spec for groundedness instance. # Required. Groundedness instance. - "context": "A String", # Required. Background information provided in context used to compare against the prediction. - "prediction": "A String", # Required. Output of the evaluated model. - }, - "metricSpec": { # Spec for groundedness metric. # Required. Spec for groundedness metric. - "version": 42, # Optional. Which version to use for evaluation. - }, - }, - "instance": { # A single instance to be evaluated. Instances are used to specify the input data for evaluation, from simple string comparisons to complex, multi-turn model evaluations # The instance to be evaluated. - "agentData": { # Contains data specific to agent evaluations. # Optional. Deprecated. Use `agent_eval_data` instead. Data used for agent evaluation. - "agentConfig": { # Configuration for an Agent. # Optional. Agent configuration. - "agentId": "A String", # Optional. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. - "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. - "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. - "developerInstruction": { # Instance data used to populate placeholders in a metric prompt template. # Optional. Contains instructions from the developer for the agent. Can be static or a dynamic prompt template used with the `AgentEvent.state_delta` field. - "contents": { # List of standard Content messages from Gemini API. # List of Gemini content data. - "contents": [ # Optional. Repeated contents. - { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. - "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. - { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. - "outcome": "A String", # Required. Outcome of the code execution. - "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. - }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. - "code": "A String", # Required. The code to be executed. - "language": "A String", # Required. Programming language of the `code`. - }, - "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. - "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "functionCall": { # 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. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. - "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. - "a_key": "", # Properties of the object. - }, - "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. - "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. - { # Partial argument value of the function call. - "boolValue": True or False, # Optional. Represents a boolean value. - "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". - "nullValue": "A String", # Optional. Represents a null value. - "numberValue": 3.14, # Optional. Represents a double value. - "stringValue": "A String", # Optional. Represents a string value. - "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. - }, - ], - "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. - }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. - "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. - "fileData": { # URI based data for function response. # URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - }, - ], - "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. - "a_key": "", # Properties of the object. - }, - "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. - }, - "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. - "data": "A String", # Required. The raw bytes of the data. - "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. - "level": "A String", # The tokenization quality used for given media. - }, - "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. - "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. - "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. - "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. - "startOffset": "A String", # Optional. The start offset of the video. - }, - }, - ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. - }, - ], - }, - "text": "A String", # Text data. - }, - "subAgents": [ # Optional. The list of valid agent IDs (names) that this agent can delegate to. This defines the directed edges in the agent system graph topology. - "A String", - ], - "tools": { # Represents a list of tools for an agent. # List of tools. - "tool": [ # Optional. List of tools: each tool can have multiple function declarations. - { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). - "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. - }, - "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. - "environment": "A String", # Required. The environment being operated. - "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. - "A String", - ], - }, - "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. - "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. - "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. - "A String", - ], - }, - "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. - { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. - "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. - "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 - "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. - "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. - # Object with schema name: GoogleCloudAiplatformV1Schema - ], - "default": "", # Optional. Default value to use if the field is not specified. - "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. - "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema - }, - "description": "A String", # Optional. Description of the schema. - "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` - "A String", - ], - "example": "", # Optional. Example of an instance of this schema. - "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. - "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. - "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. - "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. - "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. - "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. - "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. - "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. - "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. - "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. - "nullable": True or False, # Optional. Indicates if the value of this field can be null. - "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. - "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. - "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema - }, - "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. - "A String", - ], - "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring - "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. - "A String", - ], - "title": "A String", # Optional. Title for the schema. - "type": "A String", # Optional. Data type of the schema field. - }, - "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. - "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. - "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. - "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. - # Object with schema name: GoogleCloudAiplatformV1Schema - ], - "default": "", # Optional. Default value to use if the field is not specified. - "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. - "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema - }, - "description": "A String", # Optional. Description of the schema. - "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` - "A String", - ], - "example": "", # Optional. Example of an instance of this schema. - "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. - "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. - "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. - "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. - "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. - "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. - "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. - "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. - "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. - "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. - "nullable": True or False, # Optional. Indicates if the value of this field can be null. - "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. - "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. - "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema - }, - "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. - "A String", - ], - "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring - "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. - "A String", - ], - "title": "A String", # Optional. Title for the schema. - "type": "A String", # Optional. Data type of the schema field. - }, - "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. - }, - ], - "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. - "enableWidget": True or False, # Optional. If true, include the widget context token in the response. - }, - "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. - "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. - "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. - "A String", - ], - }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. - "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. - "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. - "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. - }, - }, - "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation - "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. - "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } - "a_key": "", # Properties of the object. - }, - }, - "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. - "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. - "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. - "apiKeyConfig": { # The API secret. # The API secret. - "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} - "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. - }, - }, - "apiSpec": "A String", # The API spec that the external API implements. - "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. - "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. - "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. - "apiKeyString": "A String", # Optional. The API key to be used in the request directly. - "httpElementLocation": "A String", # Optional. The location of the API key. - "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. - }, - "authType": "A String", # Type of auth scheme. - "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. - "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. - }, - "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. - "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. - }, - "oauthConfig": { # Config for user oauth. # Config for user oauth. - "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. - "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. - }, - "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. - "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. - "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). - }, - }, - "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. - "index": "A String", # The ElasticSearch index to use. - "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. - "searchTemplate": "A String", # The ElasticSearch search template to use. - }, - "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search - "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. - }, - }, - "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. - "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. - { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec - "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` - "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) - }, - ], - "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` - "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` - "filter": "A String", # Optional. Filter strings to be passed to the search API. - "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. - }, - "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. - "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. - { # The definition of the Rag resource. - "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` - "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", - ], - }, - ], - "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. - "filter": { # Config for filters. # Optional. Config for filters. - "metadataFilter": "A String", # Optional. String for metadata filtering. - "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. - "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. - }, - "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. - "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. - "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). - }, - "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. - "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` - }, - }, - "topK": 42, # Optional. The number of contexts to retrieve. - }, - "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. - "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. - }, - }, - "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. - }, - }, - ], - }, - "toolsText": "A String", # A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters. - }, - "agents": { # Optional. The static Agent Configuration. This map defines the graph structure of the agent system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent (tools, instructions, sub-agents). - "a_key": { # Configuration for an Agent. - "agentId": "A String", # Optional. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. - "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. - "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. - "developerInstruction": { # Instance data used to populate placeholders in a metric prompt template. # Optional. Contains instructions from the developer for the agent. Can be static or a dynamic prompt template used with the `AgentEvent.state_delta` field. - "contents": { # List of standard Content messages from Gemini API. # List of Gemini content data. - "contents": [ # Optional. Repeated contents. - { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. - "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. - { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. - "outcome": "A String", # Required. Outcome of the code execution. - "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. - }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. - "code": "A String", # Required. The code to be executed. - "language": "A String", # Required. Programming language of the `code`. - }, - "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. - "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "functionCall": { # 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. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. - "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. - "a_key": "", # Properties of the object. - }, - "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. - "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. - { # Partial argument value of the function call. - "boolValue": True or False, # Optional. Represents a boolean value. - "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". - "nullValue": "A String", # Optional. Represents a null value. - "numberValue": 3.14, # Optional. Represents a double value. - "stringValue": "A String", # Optional. Represents a string value. - "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. - }, - ], - "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. - }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. - "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. - "fileData": { # URI based data for function response. # URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - }, - ], - "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. - "a_key": "", # Properties of the object. - }, - "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. - }, - "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. - "data": "A String", # Required. The raw bytes of the data. - "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. - "level": "A String", # The tokenization quality used for given media. - }, - "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. - "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. - "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. - "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. - "startOffset": "A String", # Optional. The start offset of the video. - }, - }, - ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. - }, - ], - }, - "text": "A String", # Text data. - }, - "subAgents": [ # Optional. The list of valid agent IDs (names) that this agent can delegate to. This defines the directed edges in the agent system graph topology. - "A String", - ], - "tools": { # Represents a list of tools for an agent. # List of tools. - "tool": [ # Optional. List of tools: each tool can have multiple function declarations. - { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). - "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. - }, - "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. - "environment": "A String", # Required. The environment being operated. - "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. - "A String", - ], - }, - "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. - "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. - "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. - "A String", - ], - }, - "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. - { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. - "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. - "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 - "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. - "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. - # Object with schema name: GoogleCloudAiplatformV1Schema - ], - "default": "", # Optional. Default value to use if the field is not specified. - "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. - "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema - }, - "description": "A String", # Optional. Description of the schema. - "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` - "A String", - ], - "example": "", # Optional. Example of an instance of this schema. - "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. - "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. - "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. - "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. - "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. - "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. - "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. - "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. - "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. - "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. - "nullable": True or False, # Optional. Indicates if the value of this field can be null. - "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. - "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. - "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema - }, - "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. - "A String", - ], - "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring - "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. - "A String", - ], - "title": "A String", # Optional. Title for the schema. - "type": "A String", # Optional. Data type of the schema field. - }, - "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. - "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. - "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. - "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. - # Object with schema name: GoogleCloudAiplatformV1Schema - ], - "default": "", # Optional. Default value to use if the field is not specified. - "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. - "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema - }, - "description": "A String", # Optional. Description of the schema. - "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` - "A String", - ], - "example": "", # Optional. Example of an instance of this schema. - "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. - "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. - "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. - "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. - "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. - "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. - "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. - "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. - "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. - "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. - "nullable": True or False, # Optional. Indicates if the value of this field can be null. - "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. - "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. - "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema - }, - "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. - "A String", - ], - "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring - "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. - "A String", - ], - "title": "A String", # Optional. Title for the schema. - "type": "A String", # Optional. Data type of the schema field. - }, - "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. - }, - ], - "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. - "enableWidget": True or False, # Optional. If true, include the widget context token in the response. - }, - "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. - "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. - "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. - "A String", - ], - }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. - "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. - "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. - "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. - }, - }, - "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation - "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. - "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } - "a_key": "", # Properties of the object. - }, - }, - "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. - "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. - "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. - "apiKeyConfig": { # The API secret. # The API secret. - "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} - "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. - }, - }, - "apiSpec": "A String", # The API spec that the external API implements. - "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. - "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. - "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. - "apiKeyString": "A String", # Optional. The API key to be used in the request directly. - "httpElementLocation": "A String", # Optional. The location of the API key. - "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. - }, - "authType": "A String", # Type of auth scheme. - "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. - "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. - }, - "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. - "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. - }, - "oauthConfig": { # Config for user oauth. # Config for user oauth. - "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. - "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. - }, - "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. - "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. - "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). - }, - }, - "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. - "index": "A String", # The ElasticSearch index to use. - "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. - "searchTemplate": "A String", # The ElasticSearch search template to use. - }, - "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search - "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. - }, - }, - "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. - "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. - { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec - "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` - "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) - }, - ], - "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` - "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` - "filter": "A String", # Optional. Filter strings to be passed to the search API. - "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. - }, - "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. - "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. - { # The definition of the Rag resource. - "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` - "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", - ], - }, - ], - "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. - "filter": { # Config for filters. # Optional. Config for filters. - "metadataFilter": "A String", # Optional. String for metadata filtering. - "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. - "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. - }, - "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. - "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. - "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). - }, - "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. - "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` - }, - }, - "topK": 42, # Optional. The number of contexts to retrieve. - }, - "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. - "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. - }, - }, - "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. - }, - }, - ], - }, - "toolsText": "A String", # A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters. - }, - }, - "developerInstruction": { # Instance data used to populate placeholders in a metric prompt template. # Optional. Deprecated. A field containing instructions from the developer for the agent. Please use `agents.developer_instruction` or `turns.events.active_instruction` instead. - "contents": { # List of standard Content messages from Gemini API. # List of Gemini content data. - "contents": [ # Optional. Repeated contents. - { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. - "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. - { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. - "outcome": "A String", # Required. Outcome of the code execution. - "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. - }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. - "code": "A String", # Required. The code to be executed. - "language": "A String", # Required. Programming language of the `code`. - }, - "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. - "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "functionCall": { # 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. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. - "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. - "a_key": "", # Properties of the object. - }, - "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. - "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. - { # Partial argument value of the function call. - "boolValue": True or False, # Optional. Represents a boolean value. - "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". - "nullValue": "A String", # Optional. Represents a null value. - "numberValue": 3.14, # Optional. Represents a double value. - "stringValue": "A String", # Optional. Represents a string value. - "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. - }, - ], - "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. - }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. - "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. - "fileData": { # URI based data for function response. # URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - }, - ], - "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. - "a_key": "", # Properties of the object. - }, - "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. - }, - "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. - "data": "A String", # Required. The raw bytes of the data. - "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. - "level": "A String", # The tokenization quality used for given media. - }, - "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. - "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. - "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. - "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. - "startOffset": "A String", # Optional. The start offset of the video. - }, - }, - ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. - }, - ], - }, - "text": "A String", # Text data. - }, - "events": { # Represents a list of events for an agent. # A list of events. - "event": [ # Optional. A list of events. - { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. - "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. - { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. - "outcome": "A String", # Required. Outcome of the code execution. - "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. - }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. - "code": "A String", # Required. The code to be executed. - "language": "A String", # Required. Programming language of the `code`. - }, - "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. - "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "functionCall": { # 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. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. - "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. - "a_key": "", # Properties of the object. - }, - "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. - "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. - { # Partial argument value of the function call. - "boolValue": True or False, # Optional. Represents a boolean value. - "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". - "nullValue": "A String", # Optional. Represents a null value. - "numberValue": 3.14, # Optional. Represents a double value. - "stringValue": "A String", # Optional. Represents a string value. - "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. - }, - ], - "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. - }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. - "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. - "fileData": { # URI based data for function response. # URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - }, - ], - "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. - "a_key": "", # Properties of the object. - }, - "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. - }, - "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. - "data": "A String", # Required. The raw bytes of the data. - "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. - "level": "A String", # The tokenization quality used for given media. - }, - "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. - "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. - "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. - "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. - "startOffset": "A String", # Optional. The start offset of the video. - }, - }, - ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. - }, - ], - }, - "tools": { # Deprecated. Represents a list of tools for an agent. # List of tools. - "tool": [ # Optional. List of tools: each tool can have multiple function declarations. - { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). - "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. - }, - "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. - "environment": "A String", # Required. The environment being operated. - "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. - "A String", - ], - }, - "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. - "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. - "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. - "A String", - ], - }, - "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. - { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. - "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. - "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 - "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. - "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. - # Object with schema name: GoogleCloudAiplatformV1Schema - ], - "default": "", # Optional. Default value to use if the field is not specified. - "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. - "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema - }, - "description": "A String", # Optional. Description of the schema. - "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` - "A String", - ], - "example": "", # Optional. Example of an instance of this schema. - "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. - "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. - "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. - "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. - "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. - "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. - "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. - "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. - "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. - "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. - "nullable": True or False, # Optional. Indicates if the value of this field can be null. - "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. - "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. - "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema - }, - "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. - "A String", - ], - "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring - "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. - "A String", - ], - "title": "A String", # Optional. Title for the schema. - "type": "A String", # Optional. Data type of the schema field. - }, - "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. - "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. - "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. - "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. - # Object with schema name: GoogleCloudAiplatformV1Schema - ], - "default": "", # Optional. Default value to use if the field is not specified. - "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. - "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema - }, - "description": "A String", # Optional. Description of the schema. - "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` - "A String", - ], - "example": "", # Optional. Example of an instance of this schema. - "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. - "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. - "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. - "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. - "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. - "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. - "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. - "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. - "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. - "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. - "nullable": True or False, # Optional. Indicates if the value of this field can be null. - "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. - "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. - "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema - }, - "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. - "A String", - ], - "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring - "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. - "A String", - ], - "title": "A String", # Optional. Title for the schema. - "type": "A String", # Optional. Data type of the schema field. - }, - "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. - }, - ], - "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. - "enableWidget": True or False, # Optional. If true, include the widget context token in the response. - }, - "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. - "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. - "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. - "A String", - ], - }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. - "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. - "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. - "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. - }, - }, - "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation - "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. - "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } - "a_key": "", # Properties of the object. - }, - }, - "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. - "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. - "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. - "apiKeyConfig": { # The API secret. # The API secret. - "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} - "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. - }, - }, - "apiSpec": "A String", # The API spec that the external API implements. - "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. - "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. - "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. - "apiKeyString": "A String", # Optional. The API key to be used in the request directly. - "httpElementLocation": "A String", # Optional. The location of the API key. - "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. - }, - "authType": "A String", # Type of auth scheme. - "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. - "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. - }, - "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. - "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. - }, - "oauthConfig": { # Config for user oauth. # Config for user oauth. - "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. - "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. - }, - "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. - "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. - "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). - }, - }, - "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. - "index": "A String", # The ElasticSearch index to use. - "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. - "searchTemplate": "A String", # The ElasticSearch search template to use. - }, - "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search - "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. - }, - }, - "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. - "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. - { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec - "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` - "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) - }, - ], - "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` - "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` - "filter": "A String", # Optional. Filter strings to be passed to the search API. - "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. - }, - "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. - "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. - { # The definition of the Rag resource. - "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` - "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", - ], - }, - ], - "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. - "filter": { # Config for filters. # Optional. Config for filters. - "metadataFilter": "A String", # Optional. String for metadata filtering. - "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. - "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. - }, - "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. - "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. - "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). - }, - "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. - "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` - }, - }, - "topK": 42, # Optional. The number of contexts to retrieve. - }, - "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. - "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. - }, - }, - "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. - }, - }, - ], - }, - "toolsText": "A String", # A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters. - "turns": [ # Optional. The chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). - { # Represents a single turn/invocation in the conversation. - "events": [ # Optional. The list of events that occurred during this turn. - { # A single event in the execution trace. - "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. - { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). - "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. - }, - "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. - "environment": "A String", # Required. The environment being operated. - "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. - "A String", - ], - }, - "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. - "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. - "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. - "A String", - ], - }, - "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. - { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. - "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. - "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 - "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. - "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. - # Object with schema name: GoogleCloudAiplatformV1Schema - ], - "default": "", # Optional. Default value to use if the field is not specified. - "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. - "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema - }, - "description": "A String", # Optional. Description of the schema. - "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` - "A String", - ], - "example": "", # Optional. Example of an instance of this schema. - "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. - "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. - "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. - "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. - "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. - "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. - "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. - "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. - "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. - "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. - "nullable": True or False, # Optional. Indicates if the value of this field can be null. - "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. - "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. - "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema - }, - "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. - "A String", - ], - "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring - "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. - "A String", - ], - "title": "A String", # Optional. Title for the schema. - "type": "A String", # Optional. Data type of the schema field. - }, - "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. - "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. - "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. - "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. - # Object with schema name: GoogleCloudAiplatformV1Schema - ], - "default": "", # Optional. Default value to use if the field is not specified. - "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. - "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema - }, - "description": "A String", # Optional. Description of the schema. - "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` - "A String", - ], - "example": "", # Optional. Example of an instance of this schema. - "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. - "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. - "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. - "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. - "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. - "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. - "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. - "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. - "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. - "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. - "nullable": True or False, # Optional. Indicates if the value of this field can be null. - "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. - "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. - "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema - }, - "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. - "A String", - ], - "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring - "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. - "A String", - ], - "title": "A String", # Optional. Title for the schema. - "type": "A String", # Optional. Data type of the schema field. - }, - "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. - }, - ], - "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. - "enableWidget": True or False, # Optional. If true, include the widget context token in the response. - }, - "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. - "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. - "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. - "A String", - ], - }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. - "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. - "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. - "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. - }, - }, - "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation - "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. - "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } - "a_key": "", # Properties of the object. - }, - }, - "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. - "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. - "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. - "apiKeyConfig": { # The API secret. # The API secret. - "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} - "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. - }, - }, - "apiSpec": "A String", # The API spec that the external API implements. - "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. - "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. - "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. - "apiKeyString": "A String", # Optional. The API key to be used in the request directly. - "httpElementLocation": "A String", # Optional. The location of the API key. - "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. - }, - "authType": "A String", # Type of auth scheme. - "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. - "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. - }, - "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. - "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. - }, - "oauthConfig": { # Config for user oauth. # Config for user oauth. - "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. - "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. - }, - "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. - "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. - "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). - }, - }, - "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. - "index": "A String", # The ElasticSearch index to use. - "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. - "searchTemplate": "A String", # The ElasticSearch search template to use. - }, - "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search - "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. - }, - }, - "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. - "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. - { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec - "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` - "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) - }, - ], - "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` - "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` - "filter": "A String", # Optional. Filter strings to be passed to the search API. - "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. - }, - "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. - "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. - { # The definition of the Rag resource. - "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` - "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", - ], - }, - ], - "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. - "filter": { # Config for filters. # Optional. Config for filters. - "metadataFilter": "A String", # Optional. String for metadata filtering. - "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. - "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. - }, - "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. - "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. - "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). - }, - "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. - "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` - }, - }, - "topK": 42, # Optional. The number of contexts to retrieve. - }, - "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. - "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. - }, - }, - "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. - }, + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech 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": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, - ], - "author": "A String", # Required. The ID of the agent or entity that generated this event. - "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). - "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. - { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. - "outcome": "A String", # Required. Outcome of the code execution. - "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. - }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. - "code": "A String", # Required. The code to be executed. - "language": "A String", # Required. Programming language of the `code`. - }, - "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. - "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "functionCall": { # 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. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. - "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. - "a_key": "", # Properties of the object. - }, - "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. - "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. - { # Partial argument value of the function call. - "boolValue": True or False, # Optional. Represents a boolean value. - "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". - "nullValue": "A String", # Optional. Represents a null value. - "numberValue": 3.14, # Optional. Represents a double value. - "stringValue": "A String", # Optional. Represents a string value. - "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. - }, - ], - "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. - }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. - "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. - "fileData": { # URI based data for function response. # URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - }, - ], - "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. - "a_key": "", # Properties of the object. - }, - "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. - }, - "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. - "data": "A String", # Required. The raw bytes of the data. - "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. - "level": "A String", # The tokenization quality used for given media. - }, - "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. - "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. - "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. - "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. - "startOffset": "A String", # Optional. The start offset of the video. - }, - }, - ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. - }, - "eventTime": "A String", # Optional. The timestamp when the event occurred. - "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. - "a_key": "", # Properties of the object. }, }, ], - "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. - "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence. }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + "thinkingLevel": "A String", # Optional. The number of thoughts tokens that the model should generate. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "bleuInput": { # Input for bleu metric. # Instances and metric spec for bleu metric. + "instances": [ # Required. Repeated bleu instances. + { # Spec for bleu instance. + "prediction": "A String", # Required. Output of the evaluated model. + "reference": "A String", # Required. Ground truth used to compare against the prediction. + }, + ], + "metricSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Required. Spec for bleu score metric. + "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score. + }, + }, + "coherenceInput": { # Input for coherence metric. # Input for coherence metric. + "instance": { # Spec for coherence instance. # Required. Coherence instance. + "prediction": "A String", # Required. Output of the evaluated model. + }, + "metricSpec": { # Spec for coherence score metric. # Required. Spec for coherence score metric. + "version": 42, # Optional. Which version to use for evaluation. + }, + }, + "cometInput": { # Input for Comet metric. # Translation metrics. Input for Comet metric. + "instance": { # Spec for Comet instance - The fields used for evaluation are dependent on the comet version. # Required. Comet instance. + "prediction": "A String", # Required. Output of the evaluated model. + "reference": "A String", # Optional. Ground truth used to compare against the prediction. + "source": "A String", # Optional. Source text in original language. + }, + "metricSpec": { # Spec for Comet metric. # Required. Spec for comet metric. + "sourceLanguage": "A String", # Optional. Source language in BCP-47 format. + "targetLanguage": "A String", # Optional. Target language in BCP-47 format. Covers both prediction and reference. + "version": "A String", # Required. Which version to use for evaluation. + }, + }, + "exactMatchInput": { # Input for exact match metric. # Auto metric instances. Instances and metric spec for exact match metric. + "instances": [ # Required. Repeated exact match instances. + { # Spec for exact match instance. + "prediction": "A String", # Required. Output of the evaluated model. + "reference": "A String", # Required. Ground truth used to compare against the prediction. + }, + ], + "metricSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Required. Spec for exact match metric. + }, + }, + "fluencyInput": { # Input for fluency metric. # LLM-based metric instance. General text generation metrics, applicable to other categories. Input for fluency metric. + "instance": { # Spec for fluency instance. # Required. Fluency instance. + "prediction": "A String", # Required. Output of the evaluated model. + }, + "metricSpec": { # Spec for fluency score metric. # Required. Spec for fluency score metric. + "version": 42, # Optional. Which version to use for evaluation. + }, + }, + "fulfillmentInput": { # Input for fulfillment metric. # Input for fulfillment metric. + "instance": { # Spec for fulfillment instance. # Required. Fulfillment instance. + "instruction": "A String", # Required. Inference instruction prompt to compare prediction with. + "prediction": "A String", # Required. Output of the evaluated model. + }, + "metricSpec": { # Spec for fulfillment metric. # Required. Spec for fulfillment score metric. + "version": 42, # Optional. Which version to use for evaluation. + }, + }, + "groundednessInput": { # Input for groundedness metric. # Input for groundedness metric. + "instance": { # Spec for groundedness instance. # Required. Groundedness instance. + "context": "A String", # Required. Background information provided in context used to compare against the prediction. + "prediction": "A String", # Required. Output of the evaluated model. }, - "agentEvalData": { # Contains data specific to agent evaluations. # Optional. Data used for agent evaluation. - "agentConfig": { # Configuration for an Agent. # Optional. Agent configuration. + "metricSpec": { # Spec for groundedness metric. # Required. Spec for groundedness metric. + "version": 42, # Optional. Which version to use for evaluation. + }, + }, + "instance": { # A single instance to be evaluated. Instances are used to specify the input data for evaluation, from simple string comparisons to complex, multi-turn model evaluations # The instance to be evaluated. + "agentData": { # Deprecated: Use `agent_eval_data` instead. Contains data specific to agent evaluations. # Optional. Deprecated: Use `agent_eval_data` instead. Data used for agent evaluation. + "agentConfig": { # Deprecated: Use `google.cloud.aiplatform.master.AgentConfig` in `agent_eval_data` instead. Configuration for an Agent. # Optional. Deprecated: Use `agent_eval_data` instead. Agent configuration. "agentId": "A String", # Optional. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. @@ -2965,7 +2249,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -3005,7 +2289,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -3046,6 +2330,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -3150,7 +2440,7 @@

Method Details

"toolsText": "A String", # A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters. }, "agents": { # Optional. The static Agent Configuration. This map defines the graph structure of the agent system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent (tools, instructions, sub-agents). - "a_key": { # Configuration for an Agent. + "a_key": { # Deprecated: Use `google.cloud.aiplatform.master.AgentConfig` in `agent_eval_data` instead. Configuration for an Agent. "agentId": "A String", # Optional. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. @@ -3268,7 +2558,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -3308,7 +2598,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -3349,6 +2639,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -3453,7 +2749,7 @@

Method Details

"toolsText": "A String", # A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters. }, }, - "developerInstruction": { # Instance data used to populate placeholders in a metric prompt template. # Optional. Deprecated. A field containing instructions from the developer for the agent. Please use `agents.developer_instruction` or `turns.events.active_instruction` instead. + "developerInstruction": { # Instance data used to populate placeholders in a metric prompt template. # Optional. Deprecated: Use `agents.developer_instruction` or `turns.events.active_instruction` instead. A field containing instructions from the developer for the agent. "contents": { # List of standard Content messages from Gemini API. # List of Gemini content data. "contents": [ # Optional. Repeated contents. { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. @@ -3612,7 +2908,7 @@

Method Details

}, ], }, - "tools": { # Deprecated. Represents a list of tools for an agent. # List of tools. + "tools": { # Deprecated: Use `agent_eval_data` instead. Represents a list of tools for an agent. # List of tools. "tool": [ # Optional. List of tools: each tool can have multiple function declarations. { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. @@ -3642,7 +2938,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -3682,7 +2978,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -3723,6 +3019,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -3858,7 +3160,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -3898,7 +3200,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -3939,6 +3241,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -4512,6 +3820,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -4532,7 +3841,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -4637,6 +3946,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -4657,7 +3967,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -5547,7 +4857,7 @@

Method Details

The object takes the form of: { # Request message for EvaluationService.GenerateInstanceRubrics. - "agentConfig": { # Configuration for an Agent. # Optional. Agent configuration, required for agent-based rubric generation. + "agentConfig": { # Deprecated: Use `google.cloud.aiplatform.master.AgentConfig` in `agent_eval_data` instead. Configuration for an Agent. # Optional. Agent configuration, required for agent-based rubric generation. "agentId": "A String", # Optional. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. @@ -5665,7 +4975,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -5705,7 +5015,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -5746,6 +5056,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -5949,6 +5265,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -5969,7 +5286,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], diff --git a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html index 6d8470ac81..3504e9084e 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html @@ -335,6 +335,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -355,7 +356,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -541,7 +542,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -581,7 +582,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -622,6 +623,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -754,8 +761,8 @@

Method Details

The object takes the form of: { # Request message for PredictionService.EmbedContent. - "autoTruncate": True or False, # Optional. Whether to silently truncate the input content if it's longer than the maximum sequence length. - "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. Input content to be embedded. Required. + "autoTruncate": True or False, # Optional. Deprecated: Please use EmbedContentConfig.auto_truncate instead. Whether to silently truncate the input content if it's longer than the maximum sequence length. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content to be embedded. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. @@ -829,9 +836,9 @@

Method Details

], "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, - "outputDimensionality": 42, # Optional. Optional reduced dimension for the output embedding. If set, excessive values in the output embedding are truncated from the end. - "taskType": "A String", # Optional. The task type of the embedding. - "title": "A String", # Optional. An optional title for the text. + "outputDimensionality": 42, # Optional. Deprecated: Please use EmbedContentConfig.output_dimensionality instead. Reduced dimension for the output embedding. If set, excessive values in the output embedding are truncated from the end. + "taskType": "A String", # Optional. Deprecated: Please use EmbedContentConfig.task_type instead. The task type of the embedding. + "title": "A String", # Optional. Deprecated: Please use EmbedContentConfig.title instead. The title for the text. } x__xgafv: string, V1 error format. @@ -849,7 +856,7 @@

Method Details

], }, "truncated": True or False, # Whether the input content was truncated before generating the embedding. - "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Metadata about the response(s). + "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s). "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content. { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. "modality": "A String", # The modality that this token count applies to. @@ -1027,6 +1034,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -1047,7 +1055,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1259,7 +1267,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1299,7 +1307,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1340,6 +1348,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -1550,6 +1564,12 @@

Method Details

"googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps. { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information. + "image": { # An `Image` chunk is a piece of evidence that comes from an image search result. It contains the URI of the image search result and the URI of the image. This is used to provide the user with a link to the source of the information. # A grounding chunk from an image search result. See the `Image` message for details. + "domain": "A String", # The domain of the image search result page. + "imageUri": "A String", # The URI of the image. + "sourceUri": "A String", # The URI of the image search result page. + "title": "A String", # The title of the image search result page. + }, "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps, containing information about places or routes. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details. "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. "reviewSnippets": [ # Snippets of reviews that were used to generate the answer. @@ -1561,6 +1581,11 @@

Method Details

], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API. + "route": { # Route information from Google Maps. # Output only. Route information. + "distanceMeters": 42, # The total distance of the route, in meters. + "duration": "A String", # The total duration of the route. + "encodedPolyline": "A String", # An encoded polyline of the route. See https://developers.google.com/maps/documentation/utilities/polylinealgorithm + }, "text": "A String", # The text of the place answer. "title": "A String", # The title of the place. "uri": "A String", # The URI of the place. @@ -1586,13 +1611,16 @@

Method Details

}, ], "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search. - { # A collection of supporting references for a segment of the model's response. + { # A collection of supporting references for a segment or part of the model's response. "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored. 3.14, ], "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment. 42, ], + "renderedParts": [ # Indices into the `rendered_parts` field of the `GroundingMetadata` message. These indices specify which rendered parts are associated with this support message. + 42, + ], "segment": { # A segment of the content. # The content segment that this support message applies to. "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index. "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content. @@ -1601,6 +1629,9 @@

Method Details

}, }, ], + "imageSearchQueries": [ # Optional. The image search queries that were used to generate the content. This field is populated only when the grounding source is Google Search with the Image Search search_type enabled. + "A String", + ], "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, @@ -2126,6 +2157,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -2146,7 +2178,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2358,7 +2390,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2398,7 +2430,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2439,6 +2471,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -2649,6 +2687,12 @@

Method Details

"googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps. { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information. + "image": { # An `Image` chunk is a piece of evidence that comes from an image search result. It contains the URI of the image search result and the URI of the image. This is used to provide the user with a link to the source of the information. # A grounding chunk from an image search result. See the `Image` message for details. + "domain": "A String", # The domain of the image search result page. + "imageUri": "A String", # The URI of the image. + "sourceUri": "A String", # The URI of the image search result page. + "title": "A String", # The title of the image search result page. + }, "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps, containing information about places or routes. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details. "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. "reviewSnippets": [ # Snippets of reviews that were used to generate the answer. @@ -2660,6 +2704,11 @@

Method Details

], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API. + "route": { # Route information from Google Maps. # Output only. Route information. + "distanceMeters": 42, # The total distance of the route, in meters. + "duration": "A String", # The total duration of the route. + "encodedPolyline": "A String", # An encoded polyline of the route. See https://developers.google.com/maps/documentation/utilities/polylinealgorithm + }, "text": "A String", # The text of the place answer. "title": "A String", # The title of the place. "uri": "A String", # The URI of the place. @@ -2685,13 +2734,16 @@

Method Details

}, ], "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search. - { # A collection of supporting references for a segment of the model's response. + { # A collection of supporting references for a segment or part of the model's response. "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored. 3.14, ], "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment. 42, ], + "renderedParts": [ # Indices into the `rendered_parts` field of the `GroundingMetadata` message. These indices specify which rendered parts are associated with this support message. + 42, + ], "segment": { # A segment of the content. # The content segment that this support message applies to. "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index. "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content. @@ -2700,6 +2752,9 @@

Method Details

}, }, ], + "imageSearchQueries": [ # Optional. The image search queries that were used to generate the content. This field is populated only when the grounding source is Google Search with the Image Search search_type enabled. + "A String", + ], "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, diff --git a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sessions.events.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sessions.events.html index 8ce85e3214..747ce26473 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sessions.events.html +++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sessions.events.html @@ -211,6 +211,12 @@

Method Details

"googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps. { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information. + "image": { # An `Image` chunk is a piece of evidence that comes from an image search result. It contains the URI of the image search result and the URI of the image. This is used to provide the user with a link to the source of the information. # A grounding chunk from an image search result. See the `Image` message for details. + "domain": "A String", # The domain of the image search result page. + "imageUri": "A String", # The URI of the image. + "sourceUri": "A String", # The URI of the image search result page. + "title": "A String", # The title of the image search result page. + }, "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps, containing information about places or routes. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details. "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. "reviewSnippets": [ # Snippets of reviews that were used to generate the answer. @@ -222,6 +228,11 @@

Method Details

], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API. + "route": { # Route information from Google Maps. # Output only. Route information. + "distanceMeters": 42, # The total distance of the route, in meters. + "duration": "A String", # The total duration of the route. + "encodedPolyline": "A String", # An encoded polyline of the route. See https://developers.google.com/maps/documentation/utilities/polylinealgorithm + }, "text": "A String", # The text of the place answer. "title": "A String", # The title of the place. "uri": "A String", # The URI of the place. @@ -247,13 +258,16 @@

Method Details

}, ], "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search. - { # A collection of supporting references for a segment of the model's response. + { # A collection of supporting references for a segment or part of the model's response. "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored. 3.14, ], "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment. 42, ], + "renderedParts": [ # Indices into the `rendered_parts` field of the `GroundingMetadata` message. These indices specify which rendered parts are associated with this support message. + 42, + ], "segment": { # A segment of the content. # The content segment that this support message applies to. "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index. "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content. @@ -262,6 +276,9 @@

Method Details

}, }, ], + "imageSearchQueries": [ # Optional. The image search queries that were used to generate the content. This field is populated only when the grounding source is Google Search with the Image Search search_type enabled. + "A String", + ], "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, @@ -279,10 +296,18 @@

Method Details

"A String", ], }, + "inputTranscription": { # Audio transcription in Server Content. # Optional. Audio transcription of user input. + "finished": True or False, # Optional. The bool indicates the end of the transcription. + "text": "A String", # Optional. Transcription text. + }, "interrupted": True or False, # Optional. Flag indicating that LLM was interrupted when generating the content. Usually it's due to user interruption during a bidi streaming. "longRunningToolIds": [ # Optional. Set of ids of the long running function calls. Agent client will know from this field about which function call is long running. Only valid for function call event. "A String", ], + "outputTranscription": { # Audio transcription in Server Content. # Optional. Audio transcription of model output. + "finished": True or False, # Optional. The bool indicates the end of the transcription. + "text": "A String", # Optional. Transcription text. + }, "partial": True or False, # Optional. Indicates whether the text content is part of a unfinished text stream. Only used for streaming mode and when the content is plain text. "turnComplete": True or False, # Optional. Indicates whether the response from the model is complete. Only used for streaming mode. }, diff --git a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sessions.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sessions.html index 8aff8f9bd6..86ab40efd0 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sessions.html +++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sessions.html @@ -219,6 +219,12 @@

Method Details

"googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps. { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information. + "image": { # An `Image` chunk is a piece of evidence that comes from an image search result. It contains the URI of the image search result and the URI of the image. This is used to provide the user with a link to the source of the information. # A grounding chunk from an image search result. See the `Image` message for details. + "domain": "A String", # The domain of the image search result page. + "imageUri": "A String", # The URI of the image. + "sourceUri": "A String", # The URI of the image search result page. + "title": "A String", # The title of the image search result page. + }, "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps, containing information about places or routes. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details. "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. "reviewSnippets": [ # Snippets of reviews that were used to generate the answer. @@ -230,6 +236,11 @@

Method Details

], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API. + "route": { # Route information from Google Maps. # Output only. Route information. + "distanceMeters": 42, # The total distance of the route, in meters. + "duration": "A String", # The total duration of the route. + "encodedPolyline": "A String", # An encoded polyline of the route. See https://developers.google.com/maps/documentation/utilities/polylinealgorithm + }, "text": "A String", # The text of the place answer. "title": "A String", # The title of the place. "uri": "A String", # The URI of the place. @@ -255,13 +266,16 @@

Method Details

}, ], "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search. - { # A collection of supporting references for a segment of the model's response. + { # A collection of supporting references for a segment or part of the model's response. "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored. 3.14, ], "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment. 42, ], + "renderedParts": [ # Indices into the `rendered_parts` field of the `GroundingMetadata` message. These indices specify which rendered parts are associated with this support message. + 42, + ], "segment": { # A segment of the content. # The content segment that this support message applies to. "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index. "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content. @@ -270,6 +284,9 @@

Method Details

}, }, ], + "imageSearchQueries": [ # Optional. The image search queries that were used to generate the content. This field is populated only when the grounding source is Google Search with the Image Search search_type enabled. + "A String", + ], "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, @@ -287,10 +304,18 @@

Method Details

"A String", ], }, + "inputTranscription": { # Audio transcription in Server Content. # Optional. Audio transcription of user input. + "finished": True or False, # Optional. The bool indicates the end of the transcription. + "text": "A String", # Optional. Transcription text. + }, "interrupted": True or False, # Optional. Flag indicating that LLM was interrupted when generating the content. Usually it's due to user interruption during a bidi streaming. "longRunningToolIds": [ # Optional. Set of ids of the long running function calls. Agent client will know from this field about which function call is long running. Only valid for function call event. "A String", ], + "outputTranscription": { # Audio transcription in Server Content. # Optional. Audio transcription of model output. + "finished": True or False, # Optional. The bool indicates the end of the transcription. + "text": "A String", # Optional. Transcription text. + }, "partial": True or False, # Optional. Indicates whether the text content is part of a unfinished text stream. Only used for streaming mode and when the content is plain text. "turnComplete": True or False, # Optional. Indicates whether the response from the model is complete. Only used for streaming mode. }, diff --git a/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html b/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html index 1a67fe5865..1b7886c825 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html +++ b/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html @@ -156,6 +156,78 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, + "evaluateDatasetRuns": [ # Output only. Evaluation runs for the Tuning Job. + { # Evaluate Dataset Run Result for Tuning Job. + "checkpointId": "A String", # Output only. The checkpoint id used in the evaluation run. Only populated when evaluating checkpoints. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error of the evaluation run if any. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, + "evaluateDatasetResponse": { # The results from an evaluation run performed by the EvaluationService. # Output only. Results for EvaluationService. + "aggregationOutput": { # The aggregation result for the entire dataset and all metrics. # Output only. Aggregation statistics derived from results of EvaluationService. + "aggregationResults": [ # One AggregationResult per metric. + { # The aggregation result for a single metric. + "aggregationMetric": "A String", # Aggregation metric. + "bleuMetricValue": { # Bleu metric value for an instance. # Results for bleu metric. + "score": 3.14, # Output only. Bleu score. + }, + "customCodeExecutionResult": { # Result for custom code execution metric. # Result for code execution metric. + "score": 3.14, # Output only. Custom code execution score. + }, + "exactMatchMetricValue": { # Exact match metric value for an instance. # Results for exact match metric. + "score": 3.14, # Output only. Exact match score. + }, + "pairwiseMetricResult": { # Spec for pairwise metric result. # Result for pairwise metric. + "customOutput": { # Spec for custom output. # Output only. Spec for custom output. + "rawOutputs": { # Raw output. # Output only. List of raw output strings. + "rawOutput": [ # Output only. Raw output string. + "A String", + ], + }, + }, + "explanation": "A String", # Output only. Explanation for pairwise metric score. + "pairwiseChoice": "A String", # Output only. Pairwise metric choice. + }, + "pointwiseMetricResult": { # Spec for pointwise metric result. # Result for pointwise metric. + "customOutput": { # Spec for custom output. # Output only. Spec for custom output. + "rawOutputs": { # Raw output. # Output only. List of raw output strings. + "rawOutput": [ # Output only. Raw output string. + "A String", + ], + }, + }, + "explanation": "A String", # Output only. Explanation for pointwise metric score. + "score": 3.14, # Output only. Pointwise metric score. + }, + "rougeMetricValue": { # Rouge metric value for an instance. # Results for rouge metric. + "score": 3.14, # Output only. Rouge score. + }, + }, + ], + "dataset": { # The dataset used for evaluation. # The dataset used for evaluation & aggregation. + "bigquerySource": { # The BigQuery location for the input content. # BigQuery source holds the dataset. + "inputUri": "A String", # Required. BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`. + }, + "gcsSource": { # The Google Cloud Storage location for the input content. # Cloud storage source holds the dataset. Currently only one Cloud Storage file path is supported. + "uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards. + "A String", + ], + }, + }, + }, + "outputInfo": { # Describes the info for output of EvaluationService. # Output only. Output info for EvaluationService. + "gcsOutputDirectory": "A String", # Output only. The full path of the Cloud Storage directory created, into which the evaluation results and aggregation results are written. + }, + }, + "evaluationRun": "A String", # Output only. The resource name of the evaluation run. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run_id}`. + "operationName": "A String", # Output only. Deprecated: The updated architecture uses evaluation_run instead. + }, + ], "experiment": "A String", # Output only. The Experiment associated with this TuningJob. "labels": { # Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. "a_key": "A String", @@ -181,6 +253,549 @@

Method Details

"startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state. "state": "A String", # Output only. The detailed state of the job. "supervisedTuningSpec": { # Tuning Spec for Supervised Tuning for first party models. # Tuning Spec for Supervised Fine Tuning. + "evaluationConfig": { # Evaluation Config for Tuning Job. # Optional. Evaluation Config for Tuning Job. + "autoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Autorater config for evaluation. + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # 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. + }, + "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. + "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. + }, + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech 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": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + "thinkingLevel": "A String", # Optional. The number of thoughts tokens that the model should generate. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "inferenceGenerationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for inference generation and outputs. If not set, default generation parameters are used. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # 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. + }, + "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. + "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. + }, + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech 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": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + "thinkingLevel": "A String", # Optional. The number of thoughts tokens that the model should generate. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "metrics": [ # Required. The metrics used for evaluation. + { # The metric used for running evaluations. + "aggregationMetrics": [ # Optional. The aggregation metrics to use. + "A String", + ], + "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric. + "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score. + }, + "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric. + "parameters": { # Optional. A map of parameters for the metric, e.g. {"rouge_type": "rougeL"}. + "a_key": "", # Properties of the object. + }, + "type": "A String", # Required. The type of the computation based metric. + }, + "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. + "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function. + }, + "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. + }, + "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. + "additionalConfig": { # Optional. Optional additional configuration for the metric. + "a_key": "", # Properties of the object. + }, + "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater). + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # 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. + }, + "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. + "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. + }, + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech 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": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + "thinkingLevel": "A String", # Optional. The number of thoughts tokens that the model should generate. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model. + "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. + "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # 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. + }, + "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. + "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. + }, + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech 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": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + "thinkingLevel": "A String", # Optional. The number of thoughts tokens that the model should generate. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. + "rubricContentType": "A String", # The type of rubric content to be generated. + "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. + "A String", + ], + }, + "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. + "systemInstruction": "A String", # Optional. System instructions for the judge model. + }, + "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric. + "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response. + "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response. + "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty. + "returnRawOutput": True or False, # Optional. Whether to return raw output. + }, + "metricPromptTemplate": "A String", # Required. Metric prompt template for pairwise metric. + "systemInstruction": "A String", # Optional. System instructions for pairwise metric. + }, + "pointwiseMetricSpec": { # Spec for pointwise metric. # Spec for pointwise metric. + "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty. + "returnRawOutput": True or False, # Optional. Whether to return raw output. + }, + "metricPromptTemplate": "A String", # Required. Metric prompt template for pointwise metric. + "systemInstruction": "A String", # Optional. System instructions for pointwise metric. + }, + "predefinedMetricSpec": { # The spec for a pre-defined metric. # The spec for a pre-defined metric. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rougeSpec": { # Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. # Spec for rouge metric. + "rougeType": "A String", # Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum. + "splitSummaries": True or False, # Optional. Whether to split summaries while using rougeLsum. + "useStemmer": True or False, # Optional. Whether to use stemmer to compute rouge score. + }, + }, + ], + "outputConfig": { # Config for evaluation output. # Required. Config for evaluation output. + "gcsDestination": { # The Google Cloud Storage location where the output is to be written to. # Cloud storage destination for evaluation output. + "outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist. + }, + }, + }, "exportLastCheckpointOnly": True or False, # Optional. If set to true, disable intermediate checkpoints for SFT and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for SFT. Default is false. "hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for SFT. "adapterSize": "A String", # Optional. Adapter size for tuning. @@ -608,6 +1223,78 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, + "evaluateDatasetRuns": [ # Output only. Evaluation runs for the Tuning Job. + { # Evaluate Dataset Run Result for Tuning Job. + "checkpointId": "A String", # Output only. The checkpoint id used in the evaluation run. Only populated when evaluating checkpoints. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error of the evaluation run if any. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, + "evaluateDatasetResponse": { # The results from an evaluation run performed by the EvaluationService. # Output only. Results for EvaluationService. + "aggregationOutput": { # The aggregation result for the entire dataset and all metrics. # Output only. Aggregation statistics derived from results of EvaluationService. + "aggregationResults": [ # One AggregationResult per metric. + { # The aggregation result for a single metric. + "aggregationMetric": "A String", # Aggregation metric. + "bleuMetricValue": { # Bleu metric value for an instance. # Results for bleu metric. + "score": 3.14, # Output only. Bleu score. + }, + "customCodeExecutionResult": { # Result for custom code execution metric. # Result for code execution metric. + "score": 3.14, # Output only. Custom code execution score. + }, + "exactMatchMetricValue": { # Exact match metric value for an instance. # Results for exact match metric. + "score": 3.14, # Output only. Exact match score. + }, + "pairwiseMetricResult": { # Spec for pairwise metric result. # Result for pairwise metric. + "customOutput": { # Spec for custom output. # Output only. Spec for custom output. + "rawOutputs": { # Raw output. # Output only. List of raw output strings. + "rawOutput": [ # Output only. Raw output string. + "A String", + ], + }, + }, + "explanation": "A String", # Output only. Explanation for pairwise metric score. + "pairwiseChoice": "A String", # Output only. Pairwise metric choice. + }, + "pointwiseMetricResult": { # Spec for pointwise metric result. # Result for pointwise metric. + "customOutput": { # Spec for custom output. # Output only. Spec for custom output. + "rawOutputs": { # Raw output. # Output only. List of raw output strings. + "rawOutput": [ # Output only. Raw output string. + "A String", + ], + }, + }, + "explanation": "A String", # Output only. Explanation for pointwise metric score. + "score": 3.14, # Output only. Pointwise metric score. + }, + "rougeMetricValue": { # Rouge metric value for an instance. # Results for rouge metric. + "score": 3.14, # Output only. Rouge score. + }, + }, + ], + "dataset": { # The dataset used for evaluation. # The dataset used for evaluation & aggregation. + "bigquerySource": { # The BigQuery location for the input content. # BigQuery source holds the dataset. + "inputUri": "A String", # Required. BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`. + }, + "gcsSource": { # The Google Cloud Storage location for the input content. # Cloud storage source holds the dataset. Currently only one Cloud Storage file path is supported. + "uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards. + "A String", + ], + }, + }, + }, + "outputInfo": { # Describes the info for output of EvaluationService. # Output only. Output info for EvaluationService. + "gcsOutputDirectory": "A String", # Output only. The full path of the Cloud Storage directory created, into which the evaluation results and aggregation results are written. + }, + }, + "evaluationRun": "A String", # Output only. The resource name of the evaluation run. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run_id}`. + "operationName": "A String", # Output only. Deprecated: The updated architecture uses evaluation_run instead. + }, + ], "experiment": "A String", # Output only. The Experiment associated with this TuningJob. "labels": { # Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. "a_key": "A String", @@ -633,61 +1320,604 @@

Method Details

"startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state. "state": "A String", # Output only. The detailed state of the job. "supervisedTuningSpec": { # Tuning Spec for Supervised Tuning for first party models. # Tuning Spec for Supervised Fine Tuning. - "exportLastCheckpointOnly": True or False, # Optional. If set to true, disable intermediate checkpoints for SFT and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for SFT. Default is false. - "hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for SFT. - "adapterSize": "A String", # Optional. Adapter size for tuning. - "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training. - "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. - }, - "tunedModel": { # The Model Registry Model and Online Prediction Endpoint associated with this TuningJob. # Output only. The tuned model resources associated with this TuningJob. - "checkpoints": [ # Output only. The checkpoints associated with this TunedModel. This field is only populated for tuning jobs that enable intermediate checkpoints. - { # TunedModelCheckpoint for the Tuned Model of a Tuning Job. - "checkpointId": "A String", # The ID of the checkpoint. - "endpoint": "A String", # The Endpoint resource name that the checkpoint is deployed to. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`. - "epoch": "A String", # The epoch of the checkpoint. - "step": "A String", # The step of the checkpoint. - }, - ], - "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, 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. 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. - "preferenceOptimizationDataStats": { # Statistics computed for datasets used for preference optimization. # Output only. Statistics for preference optimization. - "droppedExampleIndices": [ # Output only. A partial sample of the indices (starting from 1) of the dropped examples. - "A String", - ], - "droppedExampleReasons": [ # Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped. - "A String", - ], - "scoreVariancePerExampleDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for scores variance per example. - "buckets": [ # Output only. Defines the histogram bucket. - { # Dataset bucket used to create a histogram for the distribution given a population of values. - "count": "A String", # Output only. Number of values in the bucket. - "left": 3.14, # Output only. Left bound of the bucket. - "right": 3.14, # Output only. Right bound of the bucket. - }, - ], - "max": 3.14, # Output only. The maximum of the population values. - "mean": 3.14, # Output only. The arithmetic mean of the values in the population. - "median": 3.14, # Output only. The median of the values in the population. - "min": 3.14, # Output only. The minimum of the population values. - "p5": 3.14, # Output only. The 5th percentile of the values in the population. - "p95": 3.14, # Output only. The 95th percentile of the values in the population. - "sum": 3.14, # Output only. Sum of a given population of values. - }, - "scoresDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for scores. - "buckets": [ # Output only. Defines the histogram bucket. - { # Dataset bucket used to create a histogram for the distribution given a population of values. - "count": "A String", # Output only. Number of values in the bucket. - "left": 3.14, # Output only. Left bound of the bucket. - "right": 3.14, # Output only. Right bound of the bucket. + "evaluationConfig": { # Evaluation Config for Tuning Job. # Optional. Evaluation Config for Tuning Job. + "autoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Autorater config for evaluation. + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # 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. + }, + "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. + "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, - ], - "max": 3.14, # Output only. The maximum of the population values. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech 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": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + "thinkingLevel": "A String", # Optional. The number of thoughts tokens that the model should generate. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "inferenceGenerationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for inference generation and outputs. If not set, default generation parameters are used. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # 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. + }, + "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. + "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. + }, + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech 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": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + "thinkingLevel": "A String", # Optional. The number of thoughts tokens that the model should generate. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "metrics": [ # Required. The metrics used for evaluation. + { # The metric used for running evaluations. + "aggregationMetrics": [ # Optional. The aggregation metrics to use. + "A String", + ], + "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric. + "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score. + }, + "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric. + "parameters": { # Optional. A map of parameters for the metric, e.g. {"rouge_type": "rougeL"}. + "a_key": "", # Properties of the object. + }, + "type": "A String", # Required. The type of the computation based metric. + }, + "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. + "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function. + }, + "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. + }, + "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. + "additionalConfig": { # Optional. Optional additional configuration for the metric. + "a_key": "", # Properties of the object. + }, + "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater). + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # 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. + }, + "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. + "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. + }, + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech 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": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + "thinkingLevel": "A String", # Optional. The number of thoughts tokens that the model should generate. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model. + "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. + "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # 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. + }, + "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. + "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. + }, + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech 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": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + "thinkingLevel": "A String", # Optional. The number of thoughts tokens that the model should generate. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. + "rubricContentType": "A String", # The type of rubric content to be generated. + "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. + "A String", + ], + }, + "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. + "systemInstruction": "A String", # Optional. System instructions for the judge model. + }, + "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric. + "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response. + "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response. + "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty. + "returnRawOutput": True or False, # Optional. Whether to return raw output. + }, + "metricPromptTemplate": "A String", # Required. Metric prompt template for pairwise metric. + "systemInstruction": "A String", # Optional. System instructions for pairwise metric. + }, + "pointwiseMetricSpec": { # Spec for pointwise metric. # Spec for pointwise metric. + "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty. + "returnRawOutput": True or False, # Optional. Whether to return raw output. + }, + "metricPromptTemplate": "A String", # Required. Metric prompt template for pointwise metric. + "systemInstruction": "A String", # Optional. System instructions for pointwise metric. + }, + "predefinedMetricSpec": { # The spec for a pre-defined metric. # The spec for a pre-defined metric. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rougeSpec": { # Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. # Spec for rouge metric. + "rougeType": "A String", # Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum. + "splitSummaries": True or False, # Optional. Whether to split summaries while using rougeLsum. + "useStemmer": True or False, # Optional. Whether to use stemmer to compute rouge score. + }, + }, + ], + "outputConfig": { # Config for evaluation output. # Required. Config for evaluation output. + "gcsDestination": { # The Google Cloud Storage location where the output is to be written to. # Cloud storage destination for evaluation output. + "outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist. + }, + }, + }, + "exportLastCheckpointOnly": True or False, # Optional. If set to true, disable intermediate checkpoints for SFT and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for SFT. Default is false. + "hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for SFT. + "adapterSize": "A String", # Optional. Adapter size for tuning. + "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training. + "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. + }, + "tunedModel": { # The Model Registry Model and Online Prediction Endpoint associated with this TuningJob. # Output only. The tuned model resources associated with this TuningJob. + "checkpoints": [ # Output only. The checkpoints associated with this TunedModel. This field is only populated for tuning jobs that enable intermediate checkpoints. + { # TunedModelCheckpoint for the Tuned Model of a Tuning Job. + "checkpointId": "A String", # The ID of the checkpoint. + "endpoint": "A String", # The Endpoint resource name that the checkpoint is deployed to. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`. + "epoch": "A String", # The epoch of the checkpoint. + "step": "A String", # The step of the checkpoint. + }, + ], + "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, 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. 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. + "preferenceOptimizationDataStats": { # Statistics computed for datasets used for preference optimization. # Output only. Statistics for preference optimization. + "droppedExampleIndices": [ # Output only. A partial sample of the indices (starting from 1) of the dropped examples. + "A String", + ], + "droppedExampleReasons": [ # Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped. + "A String", + ], + "scoreVariancePerExampleDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for scores variance per example. + "buckets": [ # Output only. Defines the histogram bucket. + { # Dataset bucket used to create a histogram for the distribution given a population of values. + "count": "A String", # Output only. Number of values in the bucket. + "left": 3.14, # Output only. Left bound of the bucket. + "right": 3.14, # Output only. Right bound of the bucket. + }, + ], + "max": 3.14, # Output only. The maximum of the population values. + "mean": 3.14, # Output only. The arithmetic mean of the values in the population. + "median": 3.14, # Output only. The median of the values in the population. + "min": 3.14, # Output only. The minimum of the population values. + "p5": 3.14, # Output only. The 5th percentile of the values in the population. + "p95": 3.14, # Output only. The 95th percentile of the values in the population. + "sum": 3.14, # Output only. Sum of a given population of values. + }, + "scoresDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for scores. + "buckets": [ # Output only. Defines the histogram bucket. + { # Dataset bucket used to create a histogram for the distribution given a population of values. + "count": "A String", # Output only. Number of values in the bucket. + "left": 3.14, # Output only. Left bound of the bucket. + "right": 3.14, # Output only. Right bound of the bucket. + }, + ], + "max": 3.14, # Output only. The maximum of the population values. "mean": 3.14, # Output only. The arithmetic mean of the values in the population. "median": 3.14, # Output only. The median of the values in the population. "min": 3.14, # Output only. The minimum of the population values. @@ -1067,6 +2297,78 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, + "evaluateDatasetRuns": [ # Output only. Evaluation runs for the Tuning Job. + { # Evaluate Dataset Run Result for Tuning Job. + "checkpointId": "A String", # Output only. The checkpoint id used in the evaluation run. Only populated when evaluating checkpoints. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error of the evaluation run if any. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, + "evaluateDatasetResponse": { # The results from an evaluation run performed by the EvaluationService. # Output only. Results for EvaluationService. + "aggregationOutput": { # The aggregation result for the entire dataset and all metrics. # Output only. Aggregation statistics derived from results of EvaluationService. + "aggregationResults": [ # One AggregationResult per metric. + { # The aggregation result for a single metric. + "aggregationMetric": "A String", # Aggregation metric. + "bleuMetricValue": { # Bleu metric value for an instance. # Results for bleu metric. + "score": 3.14, # Output only. Bleu score. + }, + "customCodeExecutionResult": { # Result for custom code execution metric. # Result for code execution metric. + "score": 3.14, # Output only. Custom code execution score. + }, + "exactMatchMetricValue": { # Exact match metric value for an instance. # Results for exact match metric. + "score": 3.14, # Output only. Exact match score. + }, + "pairwiseMetricResult": { # Spec for pairwise metric result. # Result for pairwise metric. + "customOutput": { # Spec for custom output. # Output only. Spec for custom output. + "rawOutputs": { # Raw output. # Output only. List of raw output strings. + "rawOutput": [ # Output only. Raw output string. + "A String", + ], + }, + }, + "explanation": "A String", # Output only. Explanation for pairwise metric score. + "pairwiseChoice": "A String", # Output only. Pairwise metric choice. + }, + "pointwiseMetricResult": { # Spec for pointwise metric result. # Result for pointwise metric. + "customOutput": { # Spec for custom output. # Output only. Spec for custom output. + "rawOutputs": { # Raw output. # Output only. List of raw output strings. + "rawOutput": [ # Output only. Raw output string. + "A String", + ], + }, + }, + "explanation": "A String", # Output only. Explanation for pointwise metric score. + "score": 3.14, # Output only. Pointwise metric score. + }, + "rougeMetricValue": { # Rouge metric value for an instance. # Results for rouge metric. + "score": 3.14, # Output only. Rouge score. + }, + }, + ], + "dataset": { # The dataset used for evaluation. # The dataset used for evaluation & aggregation. + "bigquerySource": { # The BigQuery location for the input content. # BigQuery source holds the dataset. + "inputUri": "A String", # Required. BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`. + }, + "gcsSource": { # The Google Cloud Storage location for the input content. # Cloud storage source holds the dataset. Currently only one Cloud Storage file path is supported. + "uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards. + "A String", + ], + }, + }, + }, + "outputInfo": { # Describes the info for output of EvaluationService. # Output only. Output info for EvaluationService. + "gcsOutputDirectory": "A String", # Output only. The full path of the Cloud Storage directory created, into which the evaluation results and aggregation results are written. + }, + }, + "evaluationRun": "A String", # Output only. The resource name of the evaluation run. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run_id}`. + "operationName": "A String", # Output only. Deprecated: The updated architecture uses evaluation_run instead. + }, + ], "experiment": "A String", # Output only. The Experiment associated with this TuningJob. "labels": { # Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. "a_key": "A String", @@ -1092,6 +2394,549 @@

Method Details

"startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state. "state": "A String", # Output only. The detailed state of the job. "supervisedTuningSpec": { # Tuning Spec for Supervised Tuning for first party models. # Tuning Spec for Supervised Fine Tuning. + "evaluationConfig": { # Evaluation Config for Tuning Job. # Optional. Evaluation Config for Tuning Job. + "autoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Autorater config for evaluation. + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # 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. + }, + "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. + "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. + }, + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech 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": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + "thinkingLevel": "A String", # Optional. The number of thoughts tokens that the model should generate. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "inferenceGenerationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for inference generation and outputs. If not set, default generation parameters are used. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # 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. + }, + "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. + "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. + }, + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech 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": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + "thinkingLevel": "A String", # Optional. The number of thoughts tokens that the model should generate. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "metrics": [ # Required. The metrics used for evaluation. + { # The metric used for running evaluations. + "aggregationMetrics": [ # Optional. The aggregation metrics to use. + "A String", + ], + "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric. + "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score. + }, + "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric. + "parameters": { # Optional. A map of parameters for the metric, e.g. {"rouge_type": "rougeL"}. + "a_key": "", # Properties of the object. + }, + "type": "A String", # Required. The type of the computation based metric. + }, + "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. + "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function. + }, + "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. + }, + "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. + "additionalConfig": { # Optional. Optional additional configuration for the metric. + "a_key": "", # Properties of the object. + }, + "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater). + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # 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. + }, + "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. + "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. + }, + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech 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": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + "thinkingLevel": "A String", # Optional. The number of thoughts tokens that the model should generate. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model. + "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. + "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # 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. + }, + "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. + "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. + }, + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech 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": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + "thinkingLevel": "A String", # Optional. The number of thoughts tokens that the model should generate. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. + "rubricContentType": "A String", # The type of rubric content to be generated. + "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. + "A String", + ], + }, + "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. + "systemInstruction": "A String", # Optional. System instructions for the judge model. + }, + "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric. + "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response. + "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response. + "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty. + "returnRawOutput": True or False, # Optional. Whether to return raw output. + }, + "metricPromptTemplate": "A String", # Required. Metric prompt template for pairwise metric. + "systemInstruction": "A String", # Optional. System instructions for pairwise metric. + }, + "pointwiseMetricSpec": { # Spec for pointwise metric. # Spec for pointwise metric. + "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty. + "returnRawOutput": True or False, # Optional. Whether to return raw output. + }, + "metricPromptTemplate": "A String", # Required. Metric prompt template for pointwise metric. + "systemInstruction": "A String", # Optional. System instructions for pointwise metric. + }, + "predefinedMetricSpec": { # The spec for a pre-defined metric. # The spec for a pre-defined metric. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rougeSpec": { # Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. # Spec for rouge metric. + "rougeType": "A String", # Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum. + "splitSummaries": True or False, # Optional. Whether to split summaries while using rougeLsum. + "useStemmer": True or False, # Optional. Whether to use stemmer to compute rouge score. + }, + }, + ], + "outputConfig": { # Config for evaluation output. # Required. Config for evaluation output. + "gcsDestination": { # The Google Cloud Storage location where the output is to be written to. # Cloud storage destination for evaluation output. + "outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist. + }, + }, + }, "exportLastCheckpointOnly": True or False, # Optional. If set to true, disable intermediate checkpoints for SFT and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for SFT. Default is false. "hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for SFT. "adapterSize": "A String", # Optional. Adapter size for tuning. @@ -1529,34 +3374,649 @@

Method Details

{ "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. - }, - "experiment": "A String", # Output only. The Experiment associated with this TuningJob. - "labels": { # Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. - "a_key": "A String", - }, - "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}` - }, - "preferenceOptimizationSpec": { # Tuning Spec for Preference Optimization. # Tuning Spec for Preference Optimization. - "exportLastCheckpointOnly": True or False, # Optional. If set to true, disable intermediate checkpoints for Preference Optimization and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for Preference Optimization. Default is false. - "hyperParameters": { # Hyperparameters for Preference Optimization. # Optional. Hyperparameters for Preference Optimization. - "adapterSize": "A String", # Optional. Adapter size for preference optimization. - "beta": 3.14, # Optional. Weight for KL Divergence regularization. - "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training. - "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, + "evaluateDatasetRuns": [ # Output only. Evaluation runs for the Tuning Job. + { # Evaluate Dataset Run Result for Tuning Job. + "checkpointId": "A String", # Output only. The checkpoint id used in the evaluation run. Only populated when evaluating checkpoints. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error of the evaluation run if any. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, + "evaluateDatasetResponse": { # The results from an evaluation run performed by the EvaluationService. # Output only. Results for EvaluationService. + "aggregationOutput": { # The aggregation result for the entire dataset and all metrics. # Output only. Aggregation statistics derived from results of EvaluationService. + "aggregationResults": [ # One AggregationResult per metric. + { # The aggregation result for a single metric. + "aggregationMetric": "A String", # Aggregation metric. + "bleuMetricValue": { # Bleu metric value for an instance. # Results for bleu metric. + "score": 3.14, # Output only. Bleu score. + }, + "customCodeExecutionResult": { # Result for custom code execution metric. # Result for code execution metric. + "score": 3.14, # Output only. Custom code execution score. + }, + "exactMatchMetricValue": { # Exact match metric value for an instance. # Results for exact match metric. + "score": 3.14, # Output only. Exact match score. + }, + "pairwiseMetricResult": { # Spec for pairwise metric result. # Result for pairwise metric. + "customOutput": { # Spec for custom output. # Output only. Spec for custom output. + "rawOutputs": { # Raw output. # Output only. List of raw output strings. + "rawOutput": [ # Output only. Raw output string. + "A String", + ], + }, + }, + "explanation": "A String", # Output only. Explanation for pairwise metric score. + "pairwiseChoice": "A String", # Output only. Pairwise metric choice. + }, + "pointwiseMetricResult": { # Spec for pointwise metric result. # Result for pointwise metric. + "customOutput": { # Spec for custom output. # Output only. Spec for custom output. + "rawOutputs": { # Raw output. # Output only. List of raw output strings. + "rawOutput": [ # Output only. Raw output string. + "A String", + ], + }, + }, + "explanation": "A String", # Output only. Explanation for pointwise metric score. + "score": 3.14, # Output only. Pointwise metric score. + }, + "rougeMetricValue": { # Rouge metric value for an instance. # Results for rouge metric. + "score": 3.14, # Output only. Rouge score. + }, + }, + ], + "dataset": { # The dataset used for evaluation. # The dataset used for evaluation & aggregation. + "bigquerySource": { # The BigQuery location for the input content. # BigQuery source holds the dataset. + "inputUri": "A String", # Required. BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`. + }, + "gcsSource": { # The Google Cloud Storage location for the input content. # Cloud storage source holds the dataset. Currently only one Cloud Storage file path is supported. + "uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards. + "A String", + ], + }, + }, + }, + "outputInfo": { # Describes the info for output of EvaluationService. # Output only. Output info for EvaluationService. + "gcsOutputDirectory": "A String", # Output only. The full path of the Cloud Storage directory created, into which the evaluation results and aggregation results are written. + }, + }, + "evaluationRun": "A String", # Output only. The resource name of the evaluation run. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run_id}`. + "operationName": "A String", # Output only. Deprecated: The updated architecture uses evaluation_run instead. + }, + ], + "experiment": "A String", # Output only. The Experiment associated with this TuningJob. + "labels": { # Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. + "a_key": "A String", + }, + "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}` + }, + "preferenceOptimizationSpec": { # Tuning Spec for Preference Optimization. # Tuning Spec for Preference Optimization. + "exportLastCheckpointOnly": True or False, # Optional. If set to true, disable intermediate checkpoints for Preference Optimization and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for Preference Optimization. Default is false. + "hyperParameters": { # Hyperparameters for Preference Optimization. # Optional. Hyperparameters for Preference Optimization. + "adapterSize": "A String", # Optional. Adapter size for preference optimization. + "beta": 3.14, # Optional. Weight for KL Divergence regularization. + "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training. + "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. + }, + "trainingDatasetUri": "A String", # Required. Cloud Storage path to file containing training dataset for preference optimization tuning. The dataset must be formatted as a JSONL file. + "validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for preference optimization tuning. The dataset must be formatted as a JSONL file. + }, + "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. + "supervisedTuningSpec": { # Tuning Spec for Supervised Tuning for first party models. # Tuning Spec for Supervised Fine Tuning. + "evaluationConfig": { # Evaluation Config for Tuning Job. # Optional. Evaluation Config for Tuning Job. + "autoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Autorater config for evaluation. + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # 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. + }, + "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. + "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. + }, + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech 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": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + "thinkingLevel": "A String", # Optional. The number of thoughts tokens that the model should generate. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "inferenceGenerationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for inference generation and outputs. If not set, default generation parameters are used. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # 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. + }, + "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. + "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. + }, + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech 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": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + "thinkingLevel": "A String", # Optional. The number of thoughts tokens that the model should generate. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "metrics": [ # Required. The metrics used for evaluation. + { # The metric used for running evaluations. + "aggregationMetrics": [ # Optional. The aggregation metrics to use. + "A String", + ], + "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric. + "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score. + }, + "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric. + "parameters": { # Optional. A map of parameters for the metric, e.g. {"rouge_type": "rougeL"}. + "a_key": "", # Properties of the object. + }, + "type": "A String", # Required. The type of the computation based metric. + }, + "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. + "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function. + }, + "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. + }, + "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. + "additionalConfig": { # Optional. Optional additional configuration for the metric. + "a_key": "", # Properties of the object. + }, + "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater). + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # 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. + }, + "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. + "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. + }, + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech 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": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + "thinkingLevel": "A String", # Optional. The number of thoughts tokens that the model should generate. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model. + "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. + "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # 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. + }, + "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. + "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. + }, + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech 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": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + "thinkingLevel": "A String", # Optional. The number of thoughts tokens that the model should generate. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. + "rubricContentType": "A String", # The type of rubric content to be generated. + "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. + "A String", + ], + }, + "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. + "systemInstruction": "A String", # Optional. System instructions for the judge model. + }, + "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric. + "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response. + "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response. + "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty. + "returnRawOutput": True or False, # Optional. Whether to return raw output. + }, + "metricPromptTemplate": "A String", # Required. Metric prompt template for pairwise metric. + "systemInstruction": "A String", # Optional. System instructions for pairwise metric. + }, + "pointwiseMetricSpec": { # Spec for pointwise metric. # Spec for pointwise metric. + "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty. + "returnRawOutput": True or False, # Optional. Whether to return raw output. + }, + "metricPromptTemplate": "A String", # Required. Metric prompt template for pointwise metric. + "systemInstruction": "A String", # Optional. System instructions for pointwise metric. + }, + "predefinedMetricSpec": { # The spec for a pre-defined metric. # The spec for a pre-defined metric. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rougeSpec": { # Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. # Spec for rouge metric. + "rougeType": "A String", # Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum. + "splitSummaries": True or False, # Optional. Whether to split summaries while using rougeLsum. + "useStemmer": True or False, # Optional. Whether to use stemmer to compute rouge score. + }, + }, + ], + "outputConfig": { # Config for evaluation output. # Required. Config for evaluation output. + "gcsDestination": { # The Google Cloud Storage location where the output is to be written to. # Cloud storage destination for evaluation output. + "outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist. + }, + }, }, - "trainingDatasetUri": "A String", # Required. Cloud Storage path to file containing training dataset for preference optimization tuning. The dataset must be formatted as a JSONL file. - "validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for preference optimization tuning. The dataset must be formatted as a JSONL file. - }, - "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. - "supervisedTuningSpec": { # Tuning Spec for Supervised Tuning for first party models. # Tuning Spec for Supervised Fine Tuning. "exportLastCheckpointOnly": True or False, # Optional. If set to true, disable intermediate checkpoints for SFT and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for SFT. Default is false. "hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for SFT. "adapterSize": "A String", # Optional. Adapter size for tuning. @@ -2012,6 +4472,78 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, + "evaluateDatasetRuns": [ # Output only. Evaluation runs for the Tuning Job. + { # Evaluate Dataset Run Result for Tuning Job. + "checkpointId": "A String", # Output only. The checkpoint id used in the evaluation run. Only populated when evaluating checkpoints. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error of the evaluation run if any. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, + "evaluateDatasetResponse": { # The results from an evaluation run performed by the EvaluationService. # Output only. Results for EvaluationService. + "aggregationOutput": { # The aggregation result for the entire dataset and all metrics. # Output only. Aggregation statistics derived from results of EvaluationService. + "aggregationResults": [ # One AggregationResult per metric. + { # The aggregation result for a single metric. + "aggregationMetric": "A String", # Aggregation metric. + "bleuMetricValue": { # Bleu metric value for an instance. # Results for bleu metric. + "score": 3.14, # Output only. Bleu score. + }, + "customCodeExecutionResult": { # Result for custom code execution metric. # Result for code execution metric. + "score": 3.14, # Output only. Custom code execution score. + }, + "exactMatchMetricValue": { # Exact match metric value for an instance. # Results for exact match metric. + "score": 3.14, # Output only. Exact match score. + }, + "pairwiseMetricResult": { # Spec for pairwise metric result. # Result for pairwise metric. + "customOutput": { # Spec for custom output. # Output only. Spec for custom output. + "rawOutputs": { # Raw output. # Output only. List of raw output strings. + "rawOutput": [ # Output only. Raw output string. + "A String", + ], + }, + }, + "explanation": "A String", # Output only. Explanation for pairwise metric score. + "pairwiseChoice": "A String", # Output only. Pairwise metric choice. + }, + "pointwiseMetricResult": { # Spec for pointwise metric result. # Result for pointwise metric. + "customOutput": { # Spec for custom output. # Output only. Spec for custom output. + "rawOutputs": { # Raw output. # Output only. List of raw output strings. + "rawOutput": [ # Output only. Raw output string. + "A String", + ], + }, + }, + "explanation": "A String", # Output only. Explanation for pointwise metric score. + "score": 3.14, # Output only. Pointwise metric score. + }, + "rougeMetricValue": { # Rouge metric value for an instance. # Results for rouge metric. + "score": 3.14, # Output only. Rouge score. + }, + }, + ], + "dataset": { # The dataset used for evaluation. # The dataset used for evaluation & aggregation. + "bigquerySource": { # The BigQuery location for the input content. # BigQuery source holds the dataset. + "inputUri": "A String", # Required. BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`. + }, + "gcsSource": { # The Google Cloud Storage location for the input content. # Cloud storage source holds the dataset. Currently only one Cloud Storage file path is supported. + "uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards. + "A String", + ], + }, + }, + }, + "outputInfo": { # Describes the info for output of EvaluationService. # Output only. Output info for EvaluationService. + "gcsOutputDirectory": "A String", # Output only. The full path of the Cloud Storage directory created, into which the evaluation results and aggregation results are written. + }, + }, + "evaluationRun": "A String", # Output only. The resource name of the evaluation run. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run_id}`. + "operationName": "A String", # Output only. Deprecated: The updated architecture uses evaluation_run instead. + }, + ], "experiment": "A String", # Output only. The Experiment associated with this TuningJob. "labels": { # Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. "a_key": "A String", @@ -2037,6 +4569,549 @@

Method Details

"startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state. "state": "A String", # Output only. The detailed state of the job. "supervisedTuningSpec": { # Tuning Spec for Supervised Tuning for first party models. # Tuning Spec for Supervised Fine Tuning. + "evaluationConfig": { # Evaluation Config for Tuning Job. # Optional. Evaluation Config for Tuning Job. + "autoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Autorater config for evaluation. + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # 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. + }, + "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. + "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. + }, + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech 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": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + "thinkingLevel": "A String", # Optional. The number of thoughts tokens that the model should generate. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "inferenceGenerationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for inference generation and outputs. If not set, default generation parameters are used. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # 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. + }, + "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. + "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. + }, + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech 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": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + "thinkingLevel": "A String", # Optional. The number of thoughts tokens that the model should generate. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "metrics": [ # Required. The metrics used for evaluation. + { # The metric used for running evaluations. + "aggregationMetrics": [ # Optional. The aggregation metrics to use. + "A String", + ], + "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric. + "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score. + }, + "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric. + "parameters": { # Optional. A map of parameters for the metric, e.g. {"rouge_type": "rougeL"}. + "a_key": "", # Properties of the object. + }, + "type": "A String", # Required. The type of the computation based metric. + }, + "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. + "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function. + }, + "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. + }, + "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. + "additionalConfig": { # Optional. Optional additional configuration for the metric. + "a_key": "", # Properties of the object. + }, + "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater). + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # 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. + }, + "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. + "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. + }, + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech 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": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + "thinkingLevel": "A String", # Optional. The number of thoughts tokens that the model should generate. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model. + "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. + "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # 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. + }, + "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. + "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. + }, + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech 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": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + "thinkingLevel": "A String", # Optional. The number of thoughts tokens that the model should generate. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. + "rubricContentType": "A String", # The type of rubric content to be generated. + "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. + "A String", + ], + }, + "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. + "systemInstruction": "A String", # Optional. System instructions for the judge model. + }, + "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric. + "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response. + "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response. + "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty. + "returnRawOutput": True or False, # Optional. Whether to return raw output. + }, + "metricPromptTemplate": "A String", # Required. Metric prompt template for pairwise metric. + "systemInstruction": "A String", # Optional. System instructions for pairwise metric. + }, + "pointwiseMetricSpec": { # Spec for pointwise metric. # Spec for pointwise metric. + "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty. + "returnRawOutput": True or False, # Optional. Whether to return raw output. + }, + "metricPromptTemplate": "A String", # Required. Metric prompt template for pointwise metric. + "systemInstruction": "A String", # Optional. System instructions for pointwise metric. + }, + "predefinedMetricSpec": { # The spec for a pre-defined metric. # The spec for a pre-defined metric. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rougeSpec": { # Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. # Spec for rouge metric. + "rougeType": "A String", # Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum. + "splitSummaries": True or False, # Optional. Whether to split summaries while using rougeLsum. + "useStemmer": True or False, # Optional. Whether to use stemmer to compute rouge score. + }, + }, + ], + "outputConfig": { # Config for evaluation output. # Required. Config for evaluation output. + "gcsDestination": { # The Google Cloud Storage location where the output is to be written to. # Cloud storage destination for evaluation output. + "outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist. + }, + }, + }, "exportLastCheckpointOnly": True or False, # Optional. If set to true, disable intermediate checkpoints for SFT and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for SFT. Default is false. "hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for SFT. "adapterSize": "A String", # Optional. Adapter size for tuning. diff --git a/docs/dyn/aiplatform_v1.publishers.models.html b/docs/dyn/aiplatform_v1.publishers.models.html index 58d4f9c14a..84e972dbc1 100644 --- a/docs/dyn/aiplatform_v1.publishers.models.html +++ b/docs/dyn/aiplatform_v1.publishers.models.html @@ -321,6 +321,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -341,7 +342,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -527,7 +528,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -567,7 +568,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -608,6 +609,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -872,6 +879,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -892,7 +900,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1104,7 +1112,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1144,7 +1152,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1185,6 +1193,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -1395,6 +1409,12 @@

Method Details

"googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps. { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information. + "image": { # An `Image` chunk is a piece of evidence that comes from an image search result. It contains the URI of the image search result and the URI of the image. This is used to provide the user with a link to the source of the information. # A grounding chunk from an image search result. See the `Image` message for details. + "domain": "A String", # The domain of the image search result page. + "imageUri": "A String", # The URI of the image. + "sourceUri": "A String", # The URI of the image search result page. + "title": "A String", # The title of the image search result page. + }, "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps, containing information about places or routes. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details. "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. "reviewSnippets": [ # Snippets of reviews that were used to generate the answer. @@ -1406,6 +1426,11 @@

Method Details

], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API. + "route": { # Route information from Google Maps. # Output only. Route information. + "distanceMeters": 42, # The total distance of the route, in meters. + "duration": "A String", # The total duration of the route. + "encodedPolyline": "A String", # An encoded polyline of the route. See https://developers.google.com/maps/documentation/utilities/polylinealgorithm + }, "text": "A String", # The text of the place answer. "title": "A String", # The title of the place. "uri": "A String", # The URI of the place. @@ -1431,13 +1456,16 @@

Method Details

}, ], "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search. - { # A collection of supporting references for a segment of the model's response. + { # A collection of supporting references for a segment or part of the model's response. "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored. 3.14, ], "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment. 42, ], + "renderedParts": [ # Indices into the `rendered_parts` field of the `GroundingMetadata` message. These indices specify which rendered parts are associated with this support message. + 42, + ], "segment": { # A segment of the content. # The content segment that this support message applies to. "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index. "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content. @@ -1446,6 +1474,9 @@

Method Details

}, }, ], + "imageSearchQueries": [ # Optional. The image search queries that were used to generate the content. This field is populated only when the grounding source is Google Search with the Image Search search_type enabled. + "A String", + ], "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, @@ -2318,6 +2349,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -2338,7 +2370,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2550,7 +2582,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2590,7 +2622,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2631,6 +2663,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -2841,6 +2879,12 @@

Method Details

"googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps. { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information. + "image": { # An `Image` chunk is a piece of evidence that comes from an image search result. It contains the URI of the image search result and the URI of the image. This is used to provide the user with a link to the source of the information. # A grounding chunk from an image search result. See the `Image` message for details. + "domain": "A String", # The domain of the image search result page. + "imageUri": "A String", # The URI of the image. + "sourceUri": "A String", # The URI of the image search result page. + "title": "A String", # The title of the image search result page. + }, "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps, containing information about places or routes. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details. "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. "reviewSnippets": [ # Snippets of reviews that were used to generate the answer. @@ -2852,6 +2896,11 @@

Method Details

], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API. + "route": { # Route information from Google Maps. # Output only. Route information. + "distanceMeters": 42, # The total distance of the route, in meters. + "duration": "A String", # The total duration of the route. + "encodedPolyline": "A String", # An encoded polyline of the route. See https://developers.google.com/maps/documentation/utilities/polylinealgorithm + }, "text": "A String", # The text of the place answer. "title": "A String", # The title of the place. "uri": "A String", # The URI of the place. @@ -2877,13 +2926,16 @@

Method Details

}, ], "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search. - { # A collection of supporting references for a segment of the model's response. + { # A collection of supporting references for a segment or part of the model's response. "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored. 3.14, ], "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment. 42, ], + "renderedParts": [ # Indices into the `rendered_parts` field of the `GroundingMetadata` message. These indices specify which rendered parts are associated with this support message. + 42, + ], "segment": { # A segment of the content. # The content segment that this support message applies to. "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index. "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content. @@ -2892,6 +2944,9 @@

Method Details

}, }, ], + "imageSearchQueries": [ # Optional. The image search queries that were used to generate the content. This field is populated only when the grounding source is Google Search with the Image Search search_type enabled. + "A String", + ], "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, diff --git a/docs/dyn/aiplatform_v1.v1.html b/docs/dyn/aiplatform_v1.v1.html index b6f34b6973..d0c7e8d854 100644 --- a/docs/dyn/aiplatform_v1.v1.html +++ b/docs/dyn/aiplatform_v1.v1.html @@ -117,6 +117,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -137,7 +138,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -268,6 +269,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -288,7 +290,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -393,6 +395,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -413,7 +416,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -593,6 +596,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -613,7 +617,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -762,8 +766,8 @@

Method Details

}, }, "instance": { # A single instance to be evaluated. Instances are used to specify the input data for evaluation, from simple string comparisons to complex, multi-turn model evaluations # The instance to be evaluated. - "agentData": { # Contains data specific to agent evaluations. # Optional. Deprecated. Use `agent_eval_data` instead. Data used for agent evaluation. - "agentConfig": { # Configuration for an Agent. # Optional. Agent configuration. + "agentData": { # Deprecated: Use `agent_eval_data` instead. Contains data specific to agent evaluations. # Optional. Deprecated: Use `agent_eval_data` instead. Data used for agent evaluation. + "agentConfig": { # Deprecated: Use `google.cloud.aiplatform.master.AgentConfig` in `agent_eval_data` instead. Configuration for an Agent. # Optional. Deprecated: Use `agent_eval_data` instead. Agent configuration. "agentId": "A String", # Optional. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. @@ -881,7 +885,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -921,7 +925,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -962,1285 +966,12 @@

Method Details

"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", ], - }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. - "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. - "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. - "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. - }, - }, - "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation - "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. - "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } - "a_key": "", # Properties of the object. - }, - }, - "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. - "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. - "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. - "apiKeyConfig": { # The API secret. # The API secret. - "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} - "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. - }, - }, - "apiSpec": "A String", # The API spec that the external API implements. - "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. - "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. - "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. - "apiKeyString": "A String", # Optional. The API key to be used in the request directly. - "httpElementLocation": "A String", # Optional. The location of the API key. - "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. - }, - "authType": "A String", # Type of auth scheme. - "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. - "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. - }, - "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. - "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. - }, - "oauthConfig": { # Config for user oauth. # Config for user oauth. - "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. - "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. - }, - "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. - "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. - "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). - }, - }, - "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. - "index": "A String", # The ElasticSearch index to use. - "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. - "searchTemplate": "A String", # The ElasticSearch search template to use. - }, - "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search - "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. - }, - }, - "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. - "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. - { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec - "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` - "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) - }, - ], - "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` - "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` - "filter": "A String", # Optional. Filter strings to be passed to the search API. - "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. - }, - "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. - "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. - { # The definition of the Rag resource. - "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` - "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", - ], - }, - ], - "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. - "filter": { # Config for filters. # Optional. Config for filters. - "metadataFilter": "A String", # Optional. String for metadata filtering. - "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. - "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. - }, - "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. - "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. - "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). - }, - "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. - "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` - }, - }, - "topK": 42, # Optional. The number of contexts to retrieve. - }, - "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. - "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. - }, - }, - "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. - }, - }, - ], - }, - "toolsText": "A String", # A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters. - }, - "agents": { # Optional. The static Agent Configuration. This map defines the graph structure of the agent system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent (tools, instructions, sub-agents). - "a_key": { # Configuration for an Agent. - "agentId": "A String", # Optional. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. - "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. - "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. - "developerInstruction": { # Instance data used to populate placeholders in a metric prompt template. # Optional. Contains instructions from the developer for the agent. Can be static or a dynamic prompt template used with the `AgentEvent.state_delta` field. - "contents": { # List of standard Content messages from Gemini API. # List of Gemini content data. - "contents": [ # Optional. Repeated contents. - { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. - "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. - { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. - "outcome": "A String", # Required. Outcome of the code execution. - "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. - }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. - "code": "A String", # Required. The code to be executed. - "language": "A String", # Required. Programming language of the `code`. - }, - "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. - "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "functionCall": { # 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. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. - "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. - "a_key": "", # Properties of the object. - }, - "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. - "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. - { # Partial argument value of the function call. - "boolValue": True or False, # Optional. Represents a boolean value. - "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". - "nullValue": "A String", # Optional. Represents a null value. - "numberValue": 3.14, # Optional. Represents a double value. - "stringValue": "A String", # Optional. Represents a string value. - "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. - }, - ], - "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. - }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. - "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. - "fileData": { # URI based data for function response. # URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - }, - ], - "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. - "a_key": "", # Properties of the object. - }, - "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. - }, - "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. - "data": "A String", # Required. The raw bytes of the data. - "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. - "level": "A String", # The tokenization quality used for given media. - }, - "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. - "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. - "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. - "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. - "startOffset": "A String", # Optional. The start offset of the video. - }, - }, - ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. - }, - ], - }, - "text": "A String", # Text data. - }, - "subAgents": [ # Optional. The list of valid agent IDs (names) that this agent can delegate to. This defines the directed edges in the agent system graph topology. - "A String", - ], - "tools": { # Represents a list of tools for an agent. # List of tools. - "tool": [ # Optional. List of tools: each tool can have multiple function declarations. - { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). - "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. - }, - "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. - "environment": "A String", # Required. The environment being operated. - "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. - "A String", - ], - }, - "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. - "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. - "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. - "A String", - ], - }, - "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. - { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. - "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. - "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 - "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. - "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. - # Object with schema name: GoogleCloudAiplatformV1Schema - ], - "default": "", # Optional. Default value to use if the field is not specified. - "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. - "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema - }, - "description": "A String", # Optional. Description of the schema. - "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` - "A String", - ], - "example": "", # Optional. Example of an instance of this schema. - "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. - "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. - "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. - "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. - "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. - "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. - "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. - "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. - "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. - "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. - "nullable": True or False, # Optional. Indicates if the value of this field can be null. - "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. - "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. - "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema - }, - "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. - "A String", - ], - "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring - "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. - "A String", - ], - "title": "A String", # Optional. Title for the schema. - "type": "A String", # Optional. Data type of the schema field. - }, - "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. - "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. - "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. - "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. - # Object with schema name: GoogleCloudAiplatformV1Schema - ], - "default": "", # Optional. Default value to use if the field is not specified. - "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. - "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema - }, - "description": "A String", # Optional. Description of the schema. - "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` - "A String", - ], - "example": "", # Optional. Example of an instance of this schema. - "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. - "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. - "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. - "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. - "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. - "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. - "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. - "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. - "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. - "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. - "nullable": True or False, # Optional. Indicates if the value of this field can be null. - "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. - "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. - "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema - }, - "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. - "A String", - ], - "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring - "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. - "A String", - ], - "title": "A String", # Optional. Title for the schema. - "type": "A String", # Optional. Data type of the schema field. - }, - "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. - }, - ], - "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. - "enableWidget": True or False, # Optional. If true, include the widget context token in the response. - }, - "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. - "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. - "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. - "A String", - ], - }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. - "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. - "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. - "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. - }, - }, - "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation - "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. - "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } - "a_key": "", # Properties of the object. - }, - }, - "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. - "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. - "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. - "apiKeyConfig": { # The API secret. # The API secret. - "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} - "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. - }, - }, - "apiSpec": "A String", # The API spec that the external API implements. - "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. - "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. - "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. - "apiKeyString": "A String", # Optional. The API key to be used in the request directly. - "httpElementLocation": "A String", # Optional. The location of the API key. - "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. - }, - "authType": "A String", # Type of auth scheme. - "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. - "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. - }, - "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. - "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. - }, - "oauthConfig": { # Config for user oauth. # Config for user oauth. - "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. - "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. - }, - "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. - "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. - "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). - }, - }, - "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. - "index": "A String", # The ElasticSearch index to use. - "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. - "searchTemplate": "A String", # The ElasticSearch search template to use. - }, - "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search - "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. - }, - }, - "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. - "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. - { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec - "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` - "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) - }, - ], - "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` - "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` - "filter": "A String", # Optional. Filter strings to be passed to the search API. - "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. - }, - "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. - "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. - { # The definition of the Rag resource. - "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` - "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", - ], - }, - ], - "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. - "filter": { # Config for filters. # Optional. Config for filters. - "metadataFilter": "A String", # Optional. String for metadata filtering. - "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. - "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. - }, - "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. - "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. - "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). - }, - "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. - "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` - }, - }, - "topK": 42, # Optional. The number of contexts to retrieve. - }, - "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. - "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. - }, - }, - "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. - }, - }, - ], - }, - "toolsText": "A String", # A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters. - }, - }, - "developerInstruction": { # Instance data used to populate placeholders in a metric prompt template. # Optional. Deprecated. A field containing instructions from the developer for the agent. Please use `agents.developer_instruction` or `turns.events.active_instruction` instead. - "contents": { # List of standard Content messages from Gemini API. # List of Gemini content data. - "contents": [ # Optional. Repeated contents. - { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. - "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. - { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. - "outcome": "A String", # Required. Outcome of the code execution. - "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. - }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. - "code": "A String", # Required. The code to be executed. - "language": "A String", # Required. Programming language of the `code`. - }, - "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. - "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "functionCall": { # 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. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. - "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. - "a_key": "", # Properties of the object. - }, - "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. - "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. - { # Partial argument value of the function call. - "boolValue": True or False, # Optional. Represents a boolean value. - "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". - "nullValue": "A String", # Optional. Represents a null value. - "numberValue": 3.14, # Optional. Represents a double value. - "stringValue": "A String", # Optional. Represents a string value. - "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. - }, - ], - "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. - }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. - "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. - "fileData": { # URI based data for function response. # URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - }, - ], - "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. - "a_key": "", # Properties of the object. - }, - "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. - }, - "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. - "data": "A String", # Required. The raw bytes of the data. - "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. - "level": "A String", # The tokenization quality used for given media. - }, - "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. - "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. - "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. - "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. - "startOffset": "A String", # Optional. The start offset of the video. - }, - }, - ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. - }, - ], - }, - "text": "A String", # Text data. - }, - "events": { # Represents a list of events for an agent. # A list of events. - "event": [ # Optional. A list of events. - { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. - "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. - { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. - "outcome": "A String", # Required. Outcome of the code execution. - "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. - }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. - "code": "A String", # Required. The code to be executed. - "language": "A String", # Required. Programming language of the `code`. - }, - "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. - "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "functionCall": { # 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. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. - "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. - "a_key": "", # Properties of the object. - }, - "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. - "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. - { # Partial argument value of the function call. - "boolValue": True or False, # Optional. Represents a boolean value. - "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". - "nullValue": "A String", # Optional. Represents a null value. - "numberValue": 3.14, # Optional. Represents a double value. - "stringValue": "A String", # Optional. Represents a string value. - "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. - }, - ], - "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. - }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. - "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. - "fileData": { # URI based data for function response. # URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - }, - ], - "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. - "a_key": "", # Properties of the object. - }, - "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. - }, - "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. - "data": "A String", # Required. The raw bytes of the data. - "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. - "level": "A String", # The tokenization quality used for given media. - }, - "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. - "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. - "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. - "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. - "startOffset": "A String", # Optional. The start offset of the video. - }, - }, - ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. - }, - ], - }, - "tools": { # Deprecated. Represents a list of tools for an agent. # List of tools. - "tool": [ # Optional. List of tools: each tool can have multiple function declarations. - { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). - "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. - }, - "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. - "environment": "A String", # Required. The environment being operated. - "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. - "A String", - ], - }, - "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. - "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. - "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. - "A String", - ], - }, - "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. - { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. - "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. - "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 - "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. - "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. - # Object with schema name: GoogleCloudAiplatformV1Schema - ], - "default": "", # Optional. Default value to use if the field is not specified. - "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. - "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema - }, - "description": "A String", # Optional. Description of the schema. - "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` - "A String", - ], - "example": "", # Optional. Example of an instance of this schema. - "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. - "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. - "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. - "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. - "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. - "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. - "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. - "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. - "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. - "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. - "nullable": True or False, # Optional. Indicates if the value of this field can be null. - "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. - "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. - "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema - }, - "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. - "A String", - ], - "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring - "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. - "A String", - ], - "title": "A String", # Optional. Title for the schema. - "type": "A String", # Optional. Data type of the schema field. - }, - "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. - "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. - "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. - "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. - # Object with schema name: GoogleCloudAiplatformV1Schema - ], - "default": "", # Optional. Default value to use if the field is not specified. - "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. - "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema - }, - "description": "A String", # Optional. Description of the schema. - "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` - "A String", - ], - "example": "", # Optional. Example of an instance of this schema. - "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. - "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. - "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. - "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. - "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. - "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. - "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. - "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. - "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. - "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. - "nullable": True or False, # Optional. Indicates if the value of this field can be null. - "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. - "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. - "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema - }, - "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. - "A String", - ], - "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring - "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. - "A String", - ], - "title": "A String", # Optional. Title for the schema. - "type": "A String", # Optional. Data type of the schema field. - }, - "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. - }, - ], - "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. - "enableWidget": True or False, # Optional. If true, include the widget context token in the response. - }, - "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. - "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. - "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. - "A String", - ], - }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. - "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. - "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. - "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. - }, - }, - "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation - "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. - "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } - "a_key": "", # Properties of the object. - }, - }, - "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. - "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. - "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. - "apiKeyConfig": { # The API secret. # The API secret. - "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} - "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. - }, - }, - "apiSpec": "A String", # The API spec that the external API implements. - "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. - "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. - "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. - "apiKeyString": "A String", # Optional. The API key to be used in the request directly. - "httpElementLocation": "A String", # Optional. The location of the API key. - "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. - }, - "authType": "A String", # Type of auth scheme. - "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. - "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. - }, - "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. - "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. - }, - "oauthConfig": { # Config for user oauth. # Config for user oauth. - "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. - "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. - }, - "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. - "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. - "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). - }, - }, - "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. - "index": "A String", # The ElasticSearch index to use. - "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. - "searchTemplate": "A String", # The ElasticSearch search template to use. - }, - "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search - "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. - }, - }, - "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. - "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. - { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec - "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` - "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) - }, - ], - "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` - "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` - "filter": "A String", # Optional. Filter strings to be passed to the search API. - "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. - }, - "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. - "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. - { # The definition of the Rag resource. - "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` - "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", - ], - }, - ], - "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. - "filter": { # Config for filters. # Optional. Config for filters. - "metadataFilter": "A String", # Optional. String for metadata filtering. - "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. - "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. - }, - "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. - "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. - "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). - }, - "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. - "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` - }, - }, - "topK": 42, # Optional. The number of contexts to retrieve. - }, - "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. - "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. - }, - }, - "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. - }, - }, - ], - }, - "toolsText": "A String", # A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters. - "turns": [ # Optional. The chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). - { # Represents a single turn/invocation in the conversation. - "events": [ # Optional. The list of events that occurred during this turn. - { # A single event in the execution trace. - "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. - { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). - "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. - }, - "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. - "environment": "A String", # Required. The environment being operated. - "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. - "A String", - ], - }, - "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. - "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. - "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. - "A String", - ], - }, - "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. - { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. - "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. - "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 - "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. - "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. - # Object with schema name: GoogleCloudAiplatformV1Schema - ], - "default": "", # Optional. Default value to use if the field is not specified. - "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. - "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema - }, - "description": "A String", # Optional. Description of the schema. - "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` - "A String", - ], - "example": "", # Optional. Example of an instance of this schema. - "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. - "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. - "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. - "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. - "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. - "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. - "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. - "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. - "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. - "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. - "nullable": True or False, # Optional. Indicates if the value of this field can be null. - "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. - "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. - "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema - }, - "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. - "A String", - ], - "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring - "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. - "A String", - ], - "title": "A String", # Optional. Title for the schema. - "type": "A String", # Optional. Data type of the schema field. - }, - "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. - "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. - "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. - "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. - # Object with schema name: GoogleCloudAiplatformV1Schema - ], - "default": "", # Optional. Default value to use if the field is not specified. - "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. - "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema - }, - "description": "A String", # Optional. Description of the schema. - "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` - "A String", - ], - "example": "", # Optional. Example of an instance of this schema. - "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. - "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. - "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. - "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. - "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. - "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. - "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. - "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. - "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. - "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. - "nullable": True or False, # Optional. Indicates if the value of this field can be null. - "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. - "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. - "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema - }, - "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. - "A String", - ], - "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring - "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. - "A String", - ], - "title": "A String", # Optional. Title for the schema. - "type": "A String", # Optional. Data type of the schema field. - }, - "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. - }, - ], - "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. - "enableWidget": True or False, # Optional. If true, include the widget context token in the response. - }, - "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. - "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. - "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. - "A String", - ], - }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. - "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. - "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. - "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. - }, - }, - "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation - "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. - "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } - "a_key": "", # Properties of the object. - }, - }, - "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. - "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. - "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. - "apiKeyConfig": { # The API secret. # The API secret. - "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} - "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. - }, - }, - "apiSpec": "A String", # The API spec that the external API implements. - "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. - "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. - "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. - "apiKeyString": "A String", # Optional. The API key to be used in the request directly. - "httpElementLocation": "A String", # Optional. The location of the API key. - "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. - }, - "authType": "A String", # Type of auth scheme. - "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. - "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. - }, - "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. - "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. - }, - "oauthConfig": { # Config for user oauth. # Config for user oauth. - "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. - "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. - }, - "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. - "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. - "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). - }, - }, - "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. - "index": "A String", # The ElasticSearch index to use. - "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. - "searchTemplate": "A String", # The ElasticSearch search template to use. - }, - "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search - "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. - }, - }, - "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. - "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. - { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec - "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` - "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) - }, - ], - "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` - "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` - "filter": "A String", # Optional. Filter strings to be passed to the search API. - "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. - }, - "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. - "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. - { # The definition of the Rag resource. - "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` - "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", - ], - }, - ], - "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. - "filter": { # Config for filters. # Optional. Config for filters. - "metadataFilter": "A String", # Optional. String for metadata filtering. - "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. - "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. - }, - "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. - "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. - "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). - }, - "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. - "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` - }, - }, - "topK": 42, # Optional. The number of contexts to retrieve. - }, - "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. - "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. - }, - }, - "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. - }, - }, - ], - "author": "A String", # Required. The ID of the agent or entity that generated this event. - "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). - "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. - { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. - "outcome": "A String", # Required. Outcome of the code execution. - "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. - }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. - "code": "A String", # Required. The code to be executed. - "language": "A String", # Required. Programming language of the `code`. - }, - "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. - "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "functionCall": { # 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. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. - "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. - "a_key": "", # Properties of the object. - }, - "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. - "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. - { # Partial argument value of the function call. - "boolValue": True or False, # Optional. Represents a boolean value. - "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". - "nullValue": "A String", # Optional. Represents a null value. - "numberValue": 3.14, # Optional. Represents a double value. - "stringValue": "A String", # Optional. Represents a string value. - "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. - }, - ], - "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. - }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. - "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. - "fileData": { # URI based data for function response. # URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - }, - ], - "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. - "a_key": "", # Properties of the object. - }, - "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. - }, - "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. - "data": "A String", # Required. The raw bytes of the data. - "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. - "level": "A String", # The tokenization quality used for given media. - }, - "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. - "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. - "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. - "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. - "startOffset": "A String", # Optional. The start offset of the video. - }, - }, - ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. - }, - "eventTime": "A String", # Optional. The timestamp when the event occurred. - "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. - "a_key": "", # Properties of the object. - }, - }, - ], - "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. - "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence. - }, - ], - }, - "agentEvalData": { # Contains data specific to agent evaluations. # Optional. Data used for agent evaluation. - "agentConfig": { # Configuration for an Agent. # Optional. Agent configuration. - "agentId": "A String", # Optional. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. - "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. - "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. - "developerInstruction": { # Instance data used to populate placeholders in a metric prompt template. # Optional. Contains instructions from the developer for the agent. Can be static or a dynamic prompt template used with the `AgentEvent.state_delta` field. - "contents": { # List of standard Content messages from Gemini API. # List of Gemini content data. - "contents": [ # Optional. Repeated contents. - { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. - "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. - { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. - "outcome": "A String", # Required. Outcome of the code execution. - "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. - }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. - "code": "A String", # Required. The code to be executed. - "language": "A String", # Required. Programming language of the `code`. - }, - "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. - "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "functionCall": { # 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. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. - "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. - "a_key": "", # Properties of the object. - }, - "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. - "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. - { # Partial argument value of the function call. - "boolValue": True or False, # Optional. Represents a boolean value. - "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". - "nullValue": "A String", # Optional. Represents a null value. - "numberValue": 3.14, # Optional. Represents a double value. - "stringValue": "A String", # Optional. Represents a string value. - "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. - }, - ], - "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. - }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. - "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. - "fileData": { # URI based data for function response. # URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - }, - ], - "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. - "a_key": "", # Properties of the object. - }, - "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. - }, - "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. - "data": "A String", # Required. The raw bytes of the data. - "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. - "level": "A String", # The tokenization quality used for given media. - }, - "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. - "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. - "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. - "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. - "startOffset": "A String", # Optional. The start offset of the video. - }, - }, - ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. - }, - ], - }, - "text": "A String", # Text data. - }, - "subAgents": [ # Optional. The list of valid agent IDs (names) that this agent can delegate to. This defines the directed edges in the agent system graph topology. - "A String", - ], - "tools": { # Represents a list of tools for an agent. # List of tools. - "tool": [ # Optional. List of tools: each tool can have multiple function declarations. - { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). - "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. - }, - "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. - "environment": "A String", # Required. The environment being operated. - "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. - "A String", - ], - }, - "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. - "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. - "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. - "A String", - ], - }, - "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. - { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. - "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. - "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 - "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. - "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. - # Object with schema name: GoogleCloudAiplatformV1Schema - ], - "default": "", # Optional. Default value to use if the field is not specified. - "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. - "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema - }, - "description": "A String", # Optional. Description of the schema. - "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` - "A String", - ], - "example": "", # Optional. Example of an instance of this schema. - "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. - "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. - "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. - "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. - "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. - "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. - "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. - "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. - "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. - "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. - "nullable": True or False, # Optional. Indicates if the value of this field can be null. - "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. - "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. - "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema - }, - "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. - "A String", - ], - "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring - "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. - "A String", - ], - "title": "A String", # Optional. Title for the schema. - "type": "A String", # Optional. Data type of the schema field. + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. }, - "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. - "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. - "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. - "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. - # Object with schema name: GoogleCloudAiplatformV1Schema - ], - "default": "", # Optional. Default value to use if the field is not specified. - "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. - "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema - }, - "description": "A String", # Optional. Description of the schema. - "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` - "A String", - ], - "example": "", # Optional. Example of an instance of this schema. - "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. - "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. - "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. - "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. - "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. - "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. - "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. - "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. - "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. - "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. - "nullable": True or False, # Optional. Indicates if the value of this field can be null. - "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. - "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. - "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema - }, - "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. - "A String", - ], - "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring - "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. - "A String", - ], - "title": "A String", # Optional. Title for the schema. - "type": "A String", # Optional. Data type of the schema field. + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. }, - "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. }, - ], - "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. - "enableWidget": True or False, # Optional. If true, include the widget context token in the response. - }, - "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. - "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. - "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. - "A String", - ], }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -2345,7 +1076,7 @@

Method Details

"toolsText": "A String", # A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters. }, "agents": { # Optional. The static Agent Configuration. This map defines the graph structure of the agent system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent (tools, instructions, sub-agents). - "a_key": { # Configuration for an Agent. + "a_key": { # Deprecated: Use `google.cloud.aiplatform.master.AgentConfig` in `agent_eval_data` instead. Configuration for an Agent. "agentId": "A String", # Optional. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. @@ -2463,7 +1194,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2503,7 +1234,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2544,6 +1275,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -2648,7 +1385,7 @@

Method Details

"toolsText": "A String", # A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters. }, }, - "developerInstruction": { # Instance data used to populate placeholders in a metric prompt template. # Optional. Deprecated. A field containing instructions from the developer for the agent. Please use `agents.developer_instruction` or `turns.events.active_instruction` instead. + "developerInstruction": { # Instance data used to populate placeholders in a metric prompt template. # Optional. Deprecated: Use `agents.developer_instruction` or `turns.events.active_instruction` instead. A field containing instructions from the developer for the agent. "contents": { # List of standard Content messages from Gemini API. # List of Gemini content data. "contents": [ # Optional. Repeated contents. { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. @@ -2807,7 +1544,7 @@

Method Details

}, ], }, - "tools": { # Deprecated. Represents a list of tools for an agent. # List of tools. + "tools": { # Deprecated: Use `agent_eval_data` instead. Represents a list of tools for an agent. # List of tools. "tool": [ # Optional. List of tools: each tool can have multiple function declarations. { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. @@ -2837,7 +1574,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2877,7 +1614,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2918,6 +1655,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -3053,7 +1796,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -3093,7 +1836,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -3134,6 +1877,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -3707,6 +2456,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -3727,7 +2477,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -3832,6 +2582,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -3852,7 +2603,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -4741,7 +3492,7 @@

Method Details

The object takes the form of: { # Request message for EvaluationService.GenerateInstanceRubrics. - "agentConfig": { # Configuration for an Agent. # Optional. Agent configuration, required for agent-based rubric generation. + "agentConfig": { # Deprecated: Use `google.cloud.aiplatform.master.AgentConfig` in `agent_eval_data` instead. Configuration for an Agent. # Optional. Agent configuration, required for agent-based rubric generation. "agentId": "A String", # Optional. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. @@ -4859,7 +3610,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -4899,7 +3650,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -4940,6 +3691,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -5143,6 +3900,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -5163,7 +3921,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], diff --git a/docs/dyn/aiplatform_v1beta1.endpoints.html b/docs/dyn/aiplatform_v1beta1.endpoints.html index 7366f1cc52..d0db801dab 100644 --- a/docs/dyn/aiplatform_v1beta1.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.endpoints.html @@ -332,6 +332,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -355,7 +356,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -543,7 +544,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -583,7 +584,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -624,6 +625,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -897,6 +904,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -920,7 +928,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1134,7 +1142,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1174,7 +1182,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1215,6 +1223,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -1434,6 +1448,12 @@

Method Details

"googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps. { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information. + "image": { # An `Image` chunk is a piece of evidence that comes from an image search result. It contains the URI of the image search result and the URI of the image. This is used to provide the user with a link to the source of the information. # A grounding chunk from an image search result. See the `Image` message for details. + "domain": "A String", # The domain of the image search result page. + "imageUri": "A String", # The URI of the image. + "sourceUri": "A String", # The URI of the image search result page. + "title": "A String", # The title of the image search result page. + }, "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps, containing information about places or routes. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details. "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. "reviewSnippets": [ # Snippets of reviews that were used to generate the answer. @@ -1445,6 +1465,11 @@

Method Details

], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API. + "route": { # Route information from Google Maps. # Output only. Route information. + "distanceMeters": 42, # The total distance of the route, in meters. + "duration": "A String", # The total duration of the route. + "encodedPolyline": "A String", # An encoded polyline of the route. See https://developers.google.com/maps/documentation/utilities/polylinealgorithm + }, "text": "A String", # The text of the place answer. "title": "A String", # The title of the place. "uri": "A String", # The URI of the place. @@ -1470,13 +1495,16 @@

Method Details

}, ], "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search. - { # A collection of supporting references for a segment of the model's response. + { # A collection of supporting references for a segment or part of the model's response. "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored. 3.14, ], "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment. 42, ], + "renderedParts": [ # Indices into the `rendered_parts` field of the `GroundingMetadata` message. These indices specify which rendered parts are associated with this support message. + 42, + ], "segment": { # A segment of the content. # The content segment that this support message applies to. "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index. "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content. @@ -1485,6 +1513,9 @@

Method Details

}, }, ], + "imageSearchQueries": [ # Optional. The image search queries that were used to generate the content. This field is populated only when the grounding source is Google Search with the Image Search search_type enabled. + "A String", + ], "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, @@ -1787,6 +1818,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -1810,7 +1842,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2024,7 +2056,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2064,7 +2096,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2105,6 +2137,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -2324,6 +2362,12 @@

Method Details

"googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps. { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information. + "image": { # An `Image` chunk is a piece of evidence that comes from an image search result. It contains the URI of the image search result and the URI of the image. This is used to provide the user with a link to the source of the information. # A grounding chunk from an image search result. See the `Image` message for details. + "domain": "A String", # The domain of the image search result page. + "imageUri": "A String", # The URI of the image. + "sourceUri": "A String", # The URI of the image search result page. + "title": "A String", # The title of the image search result page. + }, "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps, containing information about places or routes. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details. "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. "reviewSnippets": [ # Snippets of reviews that were used to generate the answer. @@ -2335,6 +2379,11 @@

Method Details

], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API. + "route": { # Route information from Google Maps. # Output only. Route information. + "distanceMeters": 42, # The total distance of the route, in meters. + "duration": "A String", # The total duration of the route. + "encodedPolyline": "A String", # An encoded polyline of the route. See https://developers.google.com/maps/documentation/utilities/polylinealgorithm + }, "text": "A String", # The text of the place answer. "title": "A String", # The title of the place. "uri": "A String", # The URI of the place. @@ -2360,13 +2409,16 @@

Method Details

}, ], "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search. - { # A collection of supporting references for a segment of the model's response. + { # A collection of supporting references for a segment or part of the model's response. "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored. 3.14, ], "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment. 42, ], + "renderedParts": [ # Indices into the `rendered_parts` field of the `GroundingMetadata` message. These indices specify which rendered parts are associated with this support message. + 42, + ], "segment": { # A segment of the content. # The content segment that this support message applies to. "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index. "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content. @@ -2375,6 +2427,9 @@

Method Details

}, }, ], + "imageSearchQueries": [ # Optional. The image search queries that were used to generate the content. This field is populated only when the grounding source is Google Search with the Image Search search_type enabled. + "A String", + ], "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, diff --git a/docs/dyn/aiplatform_v1beta1.media.html b/docs/dyn/aiplatform_v1beta1.media.html index b59e53cf15..8b133f1f9f 100644 --- a/docs/dyn/aiplatform_v1beta1.media.html +++ b/docs/dyn/aiplatform_v1beta1.media.html @@ -187,7 +187,7 @@

Method Details

"chunkSize": 42, # The size of the chunks. }, }, - "ragFileMetadataConfig": { # Metadata config for RagFile. # Specifies the metadata config for RagFiles. Including paths for metadata schema and metadata. Alteratively, inline metadata schema and metadata can be provided. + "ragFileMetadataConfig": { # Metadata config for RagFile. # Optional. Specifies the metadata config for RagFiles. Including paths for metadata schema and metadata. Alteratively, inline metadata schema and metadata can be provided. Deprecated: Not in use. "gcsMetadataSchemaSource": { # The Google Cloud Storage location for the input content. # Google Cloud Storage location. Supports importing individual files as well as entire Google Cloud Storage directories. Sample formats: - `gs://bucket_name/my_directory/object_name/metadata_schema.json` - `gs://bucket_name/my_directory` If the user provides a directory, the metadata schema will be read from the files that ends with "metadata_schema.json" in the directory. "uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards. "A String", diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html index 26ccd6e943..bb0b01e94f 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html @@ -318,7 +318,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -358,7 +358,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -399,6 +399,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -733,7 +739,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -773,7 +779,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -814,6 +820,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -1173,7 +1185,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1213,7 +1225,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1254,6 +1266,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -1599,7 +1617,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1639,7 +1657,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1680,6 +1698,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -2033,7 +2057,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2073,7 +2097,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2114,6 +2138,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -2449,7 +2479,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2489,7 +2519,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2530,6 +2560,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html index 21a6374a87..9a9287c74b 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html @@ -257,6 +257,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -280,7 +281,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -495,7 +496,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -535,7 +536,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -576,6 +577,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -832,6 +839,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -855,7 +863,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1070,7 +1078,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1110,7 +1118,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1151,6 +1159,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html index 731a52cbd4..960dd04efc 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html @@ -409,6 +409,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -432,7 +433,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -620,7 +621,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -660,7 +661,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -701,6 +702,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -2064,6 +2071,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -2087,7 +2095,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2301,7 +2309,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2341,7 +2349,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2382,6 +2390,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -2601,6 +2615,12 @@

Method Details

"googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps. { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information. + "image": { # An `Image` chunk is a piece of evidence that comes from an image search result. It contains the URI of the image search result and the URI of the image. This is used to provide the user with a link to the source of the information. # A grounding chunk from an image search result. See the `Image` message for details. + "domain": "A String", # The domain of the image search result page. + "imageUri": "A String", # The URI of the image. + "sourceUri": "A String", # The URI of the image search result page. + "title": "A String", # The title of the image search result page. + }, "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps, containing information about places or routes. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details. "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. "reviewSnippets": [ # Snippets of reviews that were used to generate the answer. @@ -2612,6 +2632,11 @@

Method Details

], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API. + "route": { # Route information from Google Maps. # Output only. Route information. + "distanceMeters": 42, # The total distance of the route, in meters. + "duration": "A String", # The total duration of the route. + "encodedPolyline": "A String", # An encoded polyline of the route. See https://developers.google.com/maps/documentation/utilities/polylinealgorithm + }, "text": "A String", # The text of the place answer. "title": "A String", # The title of the place. "uri": "A String", # The URI of the place. @@ -2637,13 +2662,16 @@

Method Details

}, ], "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search. - { # A collection of supporting references for a segment of the model's response. + { # A collection of supporting references for a segment or part of the model's response. "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored. 3.14, ], "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment. 42, ], + "renderedParts": [ # Indices into the `rendered_parts` field of the `GroundingMetadata` message. These indices specify which rendered parts are associated with this support message. + 42, + ], "segment": { # A segment of the content. # The content segment that this support message applies to. "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index. "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content. @@ -2652,6 +2680,9 @@

Method Details

}, }, ], + "imageSearchQueries": [ # Optional. The image search queries that were used to generate the content. This field is populated only when the grounding source is Google Search with the Image Search search_type enabled. + "A String", + ], "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, @@ -4699,6 +4730,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -4722,7 +4754,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -4936,7 +4968,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -4976,7 +5008,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -5017,6 +5049,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -5236,6 +5274,12 @@

Method Details

"googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps. { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information. + "image": { # An `Image` chunk is a piece of evidence that comes from an image search result. It contains the URI of the image search result and the URI of the image. This is used to provide the user with a link to the source of the information. # A grounding chunk from an image search result. See the `Image` message for details. + "domain": "A String", # The domain of the image search result page. + "imageUri": "A String", # The URI of the image. + "sourceUri": "A String", # The URI of the image search result page. + "title": "A String", # The title of the image search result page. + }, "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps, containing information about places or routes. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details. "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. "reviewSnippets": [ # Snippets of reviews that were used to generate the answer. @@ -5247,6 +5291,11 @@

Method Details

], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API. + "route": { # Route information from Google Maps. # Output only. Route information. + "distanceMeters": 42, # The total distance of the route, in meters. + "duration": "A String", # The total duration of the route. + "encodedPolyline": "A String", # An encoded polyline of the route. See https://developers.google.com/maps/documentation/utilities/polylinealgorithm + }, "text": "A String", # The text of the place answer. "title": "A String", # The title of the place. "uri": "A String", # The URI of the place. @@ -5272,13 +5321,16 @@

Method Details

}, ], "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search. - { # A collection of supporting references for a segment of the model's response. + { # A collection of supporting references for a segment or part of the model's response. "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored. 3.14, ], "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment. 42, ], + "renderedParts": [ # Indices into the `rendered_parts` field of the `GroundingMetadata` message. These indices specify which rendered parts are associated with this support message. + 42, + ], "segment": { # A segment of the content. # The content segment that this support message applies to. "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index. "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content. @@ -5287,6 +5339,9 @@

Method Details

}, }, ], + "imageSearchQueries": [ # Optional. The image search queries that were used to generate the content. This field is populated only when the grounding source is Google Search with the Image Search search_type enabled. + "A String", + ], "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.openapi.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.openapi.html index fdbf0e173a..85f4ab2e89 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.openapi.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.openapi.html @@ -83,6 +83,9 @@

Instance Methods

embeddings(endpoint, body=None, deployedModelId=None, x__xgafv=None)

Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.

+

+ responses(endpoint, body=None, deployedModelId=None, x__xgafv=None)

+

Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.

Method Details

close() @@ -167,4 +170,43 @@

Method Details

}
+
+ responses(endpoint, body=None, deployedModelId=None, x__xgafv=None) +
Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.
+
+Args:
+  endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+  deployedModelId: string, ID of the DeployedModel that serves the invoke request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html index 05ab7c8d9f..d4d6cff1f9 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html @@ -167,7 +167,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -207,7 +207,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -248,6 +248,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -390,7 +396,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -430,7 +436,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -471,6 +477,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -798,7 +810,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -838,7 +850,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -879,6 +891,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -1021,7 +1039,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1061,7 +1079,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1102,6 +1120,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -1428,7 +1452,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1468,7 +1492,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1509,6 +1533,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -1651,7 +1681,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1691,7 +1721,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1732,6 +1762,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -2101,7 +2137,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2141,7 +2177,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2182,6 +2218,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -2324,7 +2366,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2364,7 +2406,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2405,6 +2447,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -2732,7 +2780,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2772,7 +2820,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2813,6 +2861,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -2955,7 +3009,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2995,7 +3049,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -3036,6 +3090,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -3362,7 +3422,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -3402,7 +3462,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -3443,6 +3503,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -3585,7 +3651,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -3625,7 +3691,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -3666,6 +3732,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -4035,7 +4107,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -4075,7 +4147,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -4116,6 +4188,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -4258,7 +4336,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -4298,7 +4376,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -4339,6 +4417,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -4666,7 +4750,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -4706,7 +4790,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -4747,6 +4831,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -4889,7 +4979,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -4929,7 +5019,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -4970,6 +5060,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -5296,7 +5392,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -5336,7 +5432,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -5377,6 +5473,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -5519,7 +5621,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -5559,7 +5661,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -5600,6 +5702,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -5969,7 +6077,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -6009,7 +6117,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -6050,6 +6158,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -6192,7 +6306,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -6232,7 +6346,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -6273,6 +6387,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -6600,7 +6720,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -6640,7 +6760,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -6681,6 +6801,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -6823,7 +6949,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -6863,7 +6989,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -6904,6 +7030,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -7230,7 +7362,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -7270,7 +7402,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -7311,6 +7443,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -7453,7 +7591,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -7493,7 +7631,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -7534,6 +7672,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -7945,7 +8089,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -7985,7 +8129,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -8026,6 +8170,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -8168,7 +8318,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -8208,7 +8358,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -8249,6 +8399,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -8576,7 +8732,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -8616,7 +8772,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -8657,6 +8813,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -8799,7 +8961,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -8839,7 +9001,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -8880,6 +9042,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -9206,7 +9374,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -9246,7 +9414,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -9287,6 +9455,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -9429,7 +9603,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -9469,7 +9643,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -9510,6 +9684,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -9879,7 +10059,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -9919,7 +10099,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -9960,6 +10140,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -10102,7 +10288,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -10142,7 +10328,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -10183,6 +10369,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -10510,7 +10702,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -10550,7 +10742,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -10591,6 +10783,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -10733,7 +10931,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -10773,7 +10971,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -10814,6 +11012,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -11140,7 +11344,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -11180,7 +11384,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -11221,6 +11425,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -11363,7 +11573,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -11403,7 +11613,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -11444,6 +11654,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -11826,7 +12042,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -11866,7 +12082,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -11907,6 +12123,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -12049,7 +12271,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -12089,7 +12311,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -12130,6 +12352,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -12457,7 +12685,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -12497,7 +12725,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -12538,6 +12766,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -12680,7 +12914,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -12720,7 +12954,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -12761,6 +12995,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -13087,7 +13327,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -13127,7 +13367,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -13168,6 +13408,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -13310,7 +13556,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -13350,7 +13596,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -13391,6 +13637,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -13760,7 +14012,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -13800,7 +14052,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -13841,6 +14093,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -13983,7 +14241,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -14023,7 +14281,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -14064,6 +14322,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -14391,7 +14655,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -14431,7 +14695,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -14472,6 +14736,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -14614,7 +14884,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -14654,7 +14924,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -14695,6 +14965,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -15021,7 +15297,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -15061,7 +15337,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -15102,6 +15378,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -15244,7 +15526,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -15284,7 +15566,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -15325,6 +15607,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html index d7ff5c77a5..45095762ce 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html @@ -184,6 +184,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -207,7 +208,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -315,6 +316,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -338,7 +340,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -442,6 +444,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -465,7 +468,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -594,6 +597,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -617,7 +621,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -722,6 +726,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -745,7 +750,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -899,6 +904,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -922,7 +928,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1020,6 +1026,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -1043,7 +1050,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1170,6 +1177,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -1193,7 +1201,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1403,7 +1411,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1443,7 +1451,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1484,6 +1492,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -1605,6 +1619,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -1628,7 +1643,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1771,6 +1786,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -1794,7 +1810,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1902,6 +1918,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -1925,7 +1942,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2029,6 +2046,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -2052,7 +2070,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2181,6 +2199,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -2204,7 +2223,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2309,6 +2328,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -2332,7 +2352,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2486,6 +2506,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -2509,7 +2530,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2607,6 +2628,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -2630,7 +2652,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2757,6 +2779,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -2780,7 +2803,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2990,7 +3013,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -3030,7 +3053,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -3071,6 +3094,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -3192,6 +3221,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -3215,7 +3245,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -3400,6 +3430,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -3423,7 +3454,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -3531,6 +3562,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -3554,7 +3586,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -3658,6 +3690,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -3681,7 +3714,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -3810,6 +3843,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -3833,7 +3867,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -3938,6 +3972,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -3961,7 +3996,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -4115,6 +4150,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -4138,7 +4174,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -4236,6 +4272,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -4259,7 +4296,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -4386,6 +4423,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -4409,7 +4447,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -4619,7 +4657,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -4659,7 +4697,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -4700,6 +4738,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -4821,6 +4865,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -4844,7 +4889,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -5000,6 +5045,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -5023,7 +5069,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -5131,6 +5177,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -5154,7 +5201,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -5258,6 +5305,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -5281,7 +5329,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -5410,6 +5458,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -5433,7 +5482,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -5538,6 +5587,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -5561,7 +5611,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -5715,6 +5765,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -5738,7 +5789,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -5836,6 +5887,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -5859,7 +5911,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -5986,6 +6038,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -6009,7 +6062,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -6219,7 +6272,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -6259,7 +6312,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -6300,6 +6353,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -6421,6 +6480,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -6444,7 +6504,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html index 420ac1b286..d1eb498cd7 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html @@ -232,7 +232,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -272,7 +272,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -407,7 +407,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -447,7 +447,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -621,7 +621,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -661,7 +661,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -813,7 +813,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -853,7 +853,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -987,7 +987,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1027,7 +1027,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.html index 37562524d1..243a555e2c 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.html @@ -309,6 +309,12 @@

Instance Methods

Returns the tuningJobs Resource.

+

+ askContexts(parent, body=None, x__xgafv=None)

+

Agentic Retrieval Ask API for RAG.

+

+ asyncRetrieveContexts(parent, body=None, x__xgafv=None)

+

Asynchronous API to retrieves relevant contexts for a query.

augmentPrompt(parent, body=None, x__xgafv=None)

Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses.

@@ -359,110 +365,310 @@

Instance Methods

Updates a RagEngineConfig.

Method Details

- augmentPrompt(parent, body=None, x__xgafv=None) -
Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses.
+    askContexts(parent, body=None, x__xgafv=None)
+  
Agentic Retrieval Ask API for RAG.
 
 Args:
-  parent: string, Required. The resource name of the Location from which to augment prompt. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`. (required)
+  parent: string, Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`. (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request message for AugmentPrompt.
-  "contents": [ # Optional. Input content to augment, only text format is supported for now.
-    { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.
-      "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
-        { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
-          "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
-            "outcome": "A String", # Required. Outcome of the code execution.
-            "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
+{ # Agentic Retrieval Ask API for RAG. Request message for VertexRagService.AskContexts.
+  "query": { # A query to retrieve relevant contexts. # Required. Single RAG retrieve query.
+    "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the query.
+      "filter": { # Config for filters. # Optional. Config for filters.
+        "metadataFilter": "A String", # Optional. String for metadata filtering.
+        "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold.
+        "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold.
+      },
+      "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search.
+        "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally.
+      },
+      "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking.
+        "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker.
+          "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+        },
+        "rankService": { # Config for Rank Service. # Optional. Config for Rank Service.
+          "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest`
+        },
+      },
+      "topK": 42, # Optional. The number of contexts to retrieve.
+    },
+    "ranking": { # Configurations for hybrid search results ranking. # Optional. Configurations for hybrid search results ranking.
+      "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally.
+    },
+    "similarityTopK": 42, # Optional. The number of contexts to retrieve.
+    "text": "A String", # Optional. The query in text format to get relevant contexts.
+  },
+  "tools": [ # Optional. The tools to use for AskContexts.
+    { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
+      "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
+      },
+      "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations.
+        "environment": "A String", # Required. The environment being operated.
+        "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions.
+          "A String",
+        ],
+      },
+      "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+        "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
+        "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
+          "A String",
+        ],
+      },
+      "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided.
+        { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client.
+          "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.
+          "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64.
+          "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1
+            "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
+            "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.
+              # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+            ],
+            "default": "", # Optional. Default value to use if the field is not specified.
+            "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
+              "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+            },
+            "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
+            "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
+              "A String",
+            ],
+            "example": "", # Optional. Example of an instance of this schema.
+            "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.
+            "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.
+            "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.
+            "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.
+            "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.
+            "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.
+            "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.
+            "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.
+            "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.
+            "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.
+            "nullable": True or False, # Optional. Indicates if the value of this field can be null.
+            "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.
+            "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.
+              "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+            },
+            "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.
+              "A String",
+            ],
+            "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+            "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.
+              "A String",
+            ],
+            "title": "A String", # Optional. Title for the schema.
+            "type": "A String", # Optional. Data type of the schema field.
           },
-          "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
-            "code": "A String", # Required. The code to be executed.
-            "language": "A String", # Required. Programming language of the `code`.
+          "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`.
+          "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function.
+            "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
+            "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.
+              # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+            ],
+            "default": "", # Optional. Default value to use if the field is not specified.
+            "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
+              "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+            },
+            "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
+            "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
+              "A String",
+            ],
+            "example": "", # Optional. Example of an instance of this schema.
+            "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.
+            "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.
+            "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.
+            "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.
+            "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.
+            "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.
+            "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.
+            "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.
+            "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.
+            "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.
+            "nullable": True or False, # Optional. Indicates if the value of this field can be null.
+            "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.
+            "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.
+              "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+            },
+            "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.
+              "A String",
+            ],
+            "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
+            "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.
+              "A String",
+            ],
+            "title": "A String", # Optional. Title for the schema.
+            "type": "A String", # Optional. Data type of the schema field.
           },
-          "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
-            "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
-            "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
-            "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+          "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`.
+        },
+      ],
+      "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model.
+        "enableWidget": True or False, # Optional. If true, include the widget context token in the response.
+      },
+      "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+        "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
+        "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
+          "A String",
+        ],
+        "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default.
+          "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned.
           },
-          "functionCall": { # 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. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
-            "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
-              "a_key": "", # Properties of the object.
+          "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned.
+          },
+        },
+      },
+      "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search.
+        "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
+          "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
+          "mode": "A String", # The mode of the predictor to be used in dynamic retrieval.
+        },
+      },
+      "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation
+        "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details.
+        "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } }
+          "a_key": "", # Properties of the object.
+        },
+      },
+      "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
+        "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
+        "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding.
+          "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead.
+            "apiKeyConfig": { # The API secret. # The API secret.
+              "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
+              "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set.
             },
-            "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
-            "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
-            "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.
-              { # Partial argument value of the function call.
-                "boolValue": True or False, # Optional. Represents a boolean value.
-                "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data".
-                "nullValue": "A String", # Optional. Represents a null value.
-                "numberValue": 3.14, # Optional. Represents a double value.
-                "stringValue": "A String", # Optional. Represents a string value.
-                "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow.
-              },
-            ],
-            "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow.
           },
-          "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
-            "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
-            "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
-            "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
-              { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
-                "fileData": { # URI based data for function response. # URI based data.
-                  "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-                  "fileUri": "A String", # Required. URI.
-                  "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
-                },
-                "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
-                  "data": "A String", # Required. Raw bytes.
-                  "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-                  "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
-                },
-              },
-            ],
-            "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
-              "a_key": "", # Properties of the object.
+          "apiSpec": "A String", # The API spec that the external API implements.
+          "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API.
+            "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth.
+              "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource.
+              "apiKeyString": "A String", # Optional. The API key to be used in the request directly.
+              "httpElementLocation": "A String", # Optional. The location of the API key.
+              "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name.
+            },
+            "authType": "A String", # Type of auth scheme.
+            "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth.
+              "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension.
+            },
+            "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth.
+              "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource.
+            },
+            "oauthConfig": { # Config for user oauth. # Config for user oauth.
+              "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
+              "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account.
+            },
+            "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth.
+              "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
+              "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).
             },
-            "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE.
           },
-          "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
-            "data": "A String", # Required. The raw bytes of the data.
-            "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
-            "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+          "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API.
+            "index": "A String", # The ElasticSearch index to use.
+            "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param.
+            "searchTemplate": "A String", # The ElasticSearch search template to use.
           },
-          "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media.
-            "level": "A String", # The tokenization quality used for given media.
+          "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search
+          "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API.
           },
-          "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent.
-          "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
-          "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
-          "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
-            "endOffset": "A String", # Optional. The end offset of the video.
-            "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
-            "startOffset": "A String", # Optional. The start offset of the video.
+        },
+        "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
+          "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
+            { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec
+              "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
+              "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+            },
+          ],
+          "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
+          "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+          "filter": "A String", # Optional. Filter strings to be passed to the search API.
+          "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
+        },
+        "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
+          "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead.
+            "A String",
+          ],
+          "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.
+            { # The definition of the Rag resource.
+              "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
+              "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field.
+                "A String",
+              ],
+            },
+          ],
+          "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query.
+            "filter": { # Config for filters. # Optional. Config for filters.
+              "metadataFilter": "A String", # Optional. String for metadata filtering.
+              "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold.
+              "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold.
+            },
+            "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search.
+              "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally.
+            },
+            "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking.
+              "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker.
+                "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+              },
+              "rankService": { # Config for Rank Service. # Optional. Config for Rank Service.
+                "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest`
+              },
+            },
+            "topK": 42, # Optional. The number of contexts to retrieve.
           },
+          "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora.
+          "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions.
+          "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold.
         },
-      ],
-      "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
+      },
+      "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval.
+      },
     },
   ],
-  "model": { # Metadata of the backend deployed model. # Optional. Metadata of the backend deployed model.
-    "model": "A String", # Optional. The model that the user will send the augmented prompt for content generation.
-    "modelVersion": "A String", # Optional. The model version of the backend deployed model.
-  },
-  "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Optional. Retrieves contexts from the Vertex RagStore.
-    "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead.
-      "A String",
-    ],
-    "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.
-      { # The definition of the Rag resource.
-        "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
-        "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field.
-          "A String",
-        ],
+}
+
+  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 VertexRagService.AskContexts.
+  "contexts": { # Relevant contexts for one query. # The contexts of the query.
+    "contexts": [ # All its contexts.
+      { # A context of the query.
+        "chunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Context of the retrieved chunk.
+          "pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document.
+            "firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed.
+            "lastPage": 42, # Page where chunk ends in the document. Inclusive. 1-indexed.
+          },
+          "text": "A String", # The content of the chunk.
+        },
+        "distance": 3.14, # The distance between the query dense embedding vector and the context text vector.
+        "score": 3.14, # According to the underlying Vector DB and the selected metric type, the score can be either the distance or the similarity between the query and the context and its range depends on the metric type. For example, if the metric type is COSINE_DISTANCE, it represents the distance between the query and the context. The larger the distance, the less relevant the context is to the query. The range is [0, 2], while 0 means the most relevant and 2 means the least relevant.
+        "sourceDisplayName": "A String", # The file display name.
+        "sourceUri": "A String", # If the file is imported from Cloud Storage or Google Drive, source_uri will be original file URI in Cloud Storage or Google Drive; if file is uploaded, source_uri will be file display name.
+        "sparseDistance": 3.14, # The distance between the query sparse embedding vector and the context text vector.
+        "text": "A String", # The text chunk.
       },
     ],
-    "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query.
+  },
+  "response": "A String", # The Retrieval Response.
+}
+
+ +
+ asyncRetrieveContexts(parent, body=None, x__xgafv=None) +
Asynchronous API to retrieves relevant contexts for a query.
+
+Args:
+  parent: string, Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for VertexRagService.AsyncRetrieveContexts.
+  "query": { # A query to retrieve relevant contexts. # Required. Single RAG retrieve query.
+    "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the query.
       "filter": { # Config for filters. # Optional. Config for filters.
         "metadataFilter": "A String", # Optional. String for metadata filtering.
         "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold.
@@ -481,32 +687,415 @@ 

Method Details

}, "topK": 42, # Optional. The number of contexts to retrieve. }, - "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. - "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. - "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + "ranking": { # Configurations for hybrid search results ranking. # Optional. Configurations for hybrid search results ranking. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. + }, + "similarityTopK": 42, # Optional. The number of contexts to retrieve. + "text": "A String", # Optional. The query in text format to get relevant contexts. }, -} - - 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 AugmentPrompt. - "augmentedPrompt": [ # Augmented prompt, only text format is supported for now. - { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. - "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. - { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. - "outcome": "A String", # Required. Outcome of the code execution. - "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + "tools": [ # Optional. The tools to use for AskContexts. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. - "code": "A String", # Required. The code to be executed. - "language": "A String", # Required. Programming language of the `code`. + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. + "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } + "a_key": "", # Properties of the object. + }, + }, + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. + "A String", + ], + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], +} + + 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. + }, +}
+
+ +
+ augmentPrompt(parent, body=None, x__xgafv=None) +
Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses.
+
+Args:
+  parent: string, Required. The resource name of the Location from which to augment prompt. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for AugmentPrompt.
+  "contents": [ # Optional. Input content to augment, only text format is supported for now.
+    { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.
+      "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+        { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+          "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
+            "outcome": "A String", # Required. Outcome of the code execution.
+            "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
+          },
+          "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
+            "code": "A String", # Required. The code to be executed.
+            "language": "A String", # Required. Programming language of the `code`.
+          },
+          "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+            "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+            "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
+            "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+          },
+          "functionCall": { # 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. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
+            "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
+              "a_key": "", # Properties of the object.
+            },
+            "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
+            "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
+            "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.
+              { # Partial argument value of the function call.
+                "boolValue": True or False, # Optional. Represents a boolean value.
+                "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data".
+                "nullValue": "A String", # Optional. Represents a null value.
+                "numberValue": 3.14, # Optional. Represents a double value.
+                "stringValue": "A String", # Optional. Represents a string value.
+                "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow.
+              },
+            ],
+            "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow.
+          },
+          "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
+            "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
+            "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+            "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+              { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                "fileData": { # URI based data for function response. # URI based data.
+                  "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                  "fileUri": "A String", # Required. URI.
+                  "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                },
+                "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                  "data": "A String", # Required. Raw bytes.
+                  "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                  "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                },
+              },
+            ],
+            "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
+              "a_key": "", # Properties of the object.
+            },
+            "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE.
+          },
+          "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+            "data": "A String", # Required. The raw bytes of the data.
+            "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+            "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+          },
+          "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media.
+            "level": "A String", # The tokenization quality used for given media.
+          },
+          "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent.
+          "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
+          "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
+          "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+            "endOffset": "A String", # Optional. The end offset of the video.
+            "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
+            "startOffset": "A String", # Optional. The start offset of the video.
+          },
+        },
+      ],
+      "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
+    },
+  ],
+  "model": { # Metadata of the backend deployed model. # Optional. Metadata of the backend deployed model.
+    "model": "A String", # Optional. The model that the user will send the augmented prompt for content generation.
+    "modelVersion": "A String", # Optional. The model version of the backend deployed model.
+  },
+  "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Optional. Retrieves contexts from the Vertex RagStore.
+    "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead.
+      "A String",
+    ],
+    "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.
+      { # The definition of the Rag resource.
+        "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
+        "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field.
+          "A String",
+        ],
+      },
+    ],
+    "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query.
+      "filter": { # Config for filters. # Optional. Config for filters.
+        "metadataFilter": "A String", # Optional. String for metadata filtering.
+        "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold.
+        "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold.
+      },
+      "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search.
+        "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally.
+      },
+      "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking.
+        "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker.
+          "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+        },
+        "rankService": { # Config for Rank Service. # Optional. Config for Rank Service.
+          "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest`
+        },
+      },
+      "topK": 42, # Optional. The number of contexts to retrieve.
+    },
+    "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora.
+    "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions.
+    "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold.
+  },
+}
+
+  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 AugmentPrompt.
+  "augmentedPrompt": [ # Augmented prompt, only text format is supported for now.
+    { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.
+      "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+        { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+          "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
+            "outcome": "A String", # Required. Outcome of the code execution.
+            "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
+          },
+          "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
+            "code": "A String", # Required. The code to be executed.
+            "language": "A String", # Required. Programming language of the `code`.
           },
           "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
             "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
@@ -1093,6 +1682,7 @@ 

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -1116,7 +1706,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1247,6 +1837,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -1270,7 +1861,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1375,6 +1966,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -1398,7 +1990,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1579,6 +2171,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -1602,7 +2195,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1751,8 +2344,8 @@

Method Details

}, }, "instance": { # A single instance to be evaluated. Instances are used to specify the input data for evaluation, from simple string comparisons to complex, multi-turn model evaluations # The instance to be evaluated. - "agentData": { # Contains data specific to agent evaluations. # Optional. Deprecated. Use `agent_eval_data` instead. Data used for agent evaluation. - "agentConfig": { # Configuration for an Agent. # Optional. Agent configuration. + "agentData": { # Deprecated: Use `agent_eval_data` instead. Contains data specific to agent evaluations. # Optional. Deprecated: Use `agent_eval_data` instead. Data used for agent evaluation. + "agentConfig": { # Deprecated: Use `google.cloud.aiplatform.master.AgentConfig` in `agent_eval_data` instead. Configuration for an Agent. # Optional. Deprecated: Use `agent_eval_data` instead. Agent configuration. "agentId": "A String", # Optional. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. @@ -1872,7 +2465,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1912,7 +2505,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1953,6 +2546,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -2064,7 +2663,7 @@

Method Details

"toolsText": "A String", # A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters. }, "agents": { # Optional. The static Agent Configuration. This map defines the graph structure of the agent system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent (tools, instructions, sub-agents). - "a_key": { # Configuration for an Agent. + "a_key": { # Deprecated: Use `google.cloud.aiplatform.master.AgentConfig` in `agent_eval_data` instead. Configuration for an Agent. "agentId": "A String", # Optional. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. @@ -2184,7 +2783,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2224,7 +2823,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2265,6 +2864,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -2376,7 +2981,7 @@

Method Details

"toolsText": "A String", # A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters. }, }, - "developerInstruction": { # Instance data used to populate placeholders in a metric prompt template. # Optional. Deprecated. A field containing instructions from the developer for the agent. Please use `agents.developer_instruction` or `turns.events.active_instruction` instead. + "developerInstruction": { # Instance data used to populate placeholders in a metric prompt template. # Optional. Deprecated: Use `agents.developer_instruction` or `turns.events.active_instruction` instead. A field containing instructions from the developer for the agent. "contents": { # List of standard Content messages from Gemini API. # List of Gemini content data. "contents": [ # Optional. Repeated contents. { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. @@ -2539,7 +3144,7 @@

Method Details

}, ], }, - "tools": { # Deprecated. Represents a list of tools for an agent. # List of tools. + "tools": { # Deprecated: Use `agent_eval_data` instead. Represents a list of tools for an agent. # List of tools. "tool": [ # Optional. List of tools: each tool can have multiple function declarations. { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. @@ -2569,7 +3174,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2609,7 +3214,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2650,6 +3255,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -2792,7 +3403,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2832,7 +3443,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2873,6 +3484,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -3068,99 +3685,17 @@

Method Details

}, ], }, - "agentEvalData": { # Contains data specific to agent evaluations. # Optional. Data used for agent evaluation. - "agentConfig": { # Configuration for an Agent. # Optional. Agent configuration. - "agentId": "A String", # Optional. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. - "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. - "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. - "developerInstruction": { # Instance data used to populate placeholders in a metric prompt template. # Optional. Contains instructions from the developer for the agent. Can be static or a dynamic prompt template used with the `AgentEvent.state_delta` field. - "contents": { # List of standard Content messages from Gemini API. # List of Gemini content data. - "contents": [ # Optional. Repeated contents. - { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. - "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. - { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. - "outcome": "A String", # Required. Outcome of the code execution. - "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. - }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. - "code": "A String", # Required. The code to be executed. - "language": "A String", # Required. Programming language of the `code`. - }, - "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. - "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "functionCall": { # 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. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. - "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. - "a_key": "", # Properties of the object. - }, - "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. - "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. - "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. - { # Partial argument value of the function call. - "boolValue": True or False, # Optional. Represents a boolean value. - "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". - "nullValue": "A String", # Optional. Represents a null value. - "numberValue": 3.14, # Optional. Represents a double value. - "stringValue": "A String", # Optional. Represents a string value. - "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. - }, - ], - "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. - }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. - "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. - "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. - "fileData": { # URI based data for function response. # URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - }, - ], - "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. - "a_key": "", # Properties of the object. - }, - "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. - }, - "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. - "data": "A String", # Required. The raw bytes of the data. - "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. - "level": "A String", # The tokenization quality used for given media. - }, - "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. - "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. - "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. - "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. - "startOffset": "A String", # Optional. The start offset of the video. - }, - }, - ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. - }, - ], - }, - "text": "A String", # Text data. - }, - "subAgents": [ # Optional. The list of valid agent IDs (names) that this agent can delegate to. This defines the directed edges in the agent system graph topology. - "A String", - ], - "tools": { # Represents a list of tools for an agent. # List of tools. - "tool": [ # Optional. List of tools: each tool can have multiple function declarations. + "agentEvalData": { # Represents data specific to multi-turn agent evaluations. # Optional. Data used for agent evaluation. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, @@ -3189,7 +3724,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -3223,863 +3758,172 @@

Method Details

"response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. - # Object with schema name: GoogleCloudAiplatformV1beta1Schema - ], - "default": "", # Optional. Default value to use if the field is not specified. - "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. - "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema - }, - "description": "A String", # Optional. Description of the schema. - "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` - "A String", - ], - "example": "", # Optional. Example of an instance of this schema. - "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. - "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. - "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. - "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. - "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. - "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. - "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. - "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. - "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. - "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. - "nullable": True or False, # Optional. Indicates if the value of this field can be null. - "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. - "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. - "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema - }, - "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. - "A String", - ], - "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring - "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. - "A String", - ], - "title": "A String", # Optional. Title for the schema. - "type": "A String", # Optional. Data type of the schema field. - }, - "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. - }, - ], - "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. - "enableWidget": True or False, # Optional. If true, include the widget context token in the response. - }, - "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. - "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. - "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. - "A String", - ], - }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. - "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. - "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. - "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. - }, - }, - "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation - "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. - "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } - "a_key": "", # Properties of the object. - }, - }, - "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. - "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. - "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. - "apiKeyConfig": { # The API secret. # The API secret. - "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} - "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. - }, - }, - "apiSpec": "A String", # The API spec that the external API implements. - "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. - "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. - "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. - "apiKeyString": "A String", # Optional. The API key to be used in the request directly. - "httpElementLocation": "A String", # Optional. The location of the API key. - "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. - }, - "authType": "A String", # Type of auth scheme. - "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. - "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. - }, - "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. - "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. - }, - "oauthConfig": { # Config for user oauth. # Config for user oauth. - "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. - "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. - }, - "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. - "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. - "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). - }, - }, - "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. - "index": "A String", # The ElasticSearch index to use. - "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. - "searchTemplate": "A String", # The ElasticSearch search template to use. - }, - "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search - "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. - }, - }, - "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. - "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. - { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec - "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` - "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) - }, - ], - "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` - "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` - "filter": "A String", # Optional. Filter strings to be passed to the search API. - "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. - }, - "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. - "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. - "A String", - ], - "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. - { # The definition of the Rag resource. - "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` - "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", - ], - }, - ], - "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. - "filter": { # Config for filters. # Optional. Config for filters. - "metadataFilter": "A String", # Optional. String for metadata filtering. - "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. - "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. - }, - "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. - "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. - }, - "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. - "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. - "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). - }, - "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. - "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` - }, - }, - "topK": 42, # Optional. The number of contexts to retrieve. - }, - "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. - "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. - "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. - }, - }, - "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. - }, - }, - ], - }, - "toolsText": "A String", # A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters. - }, - "agents": { # Optional. The static Agent Configuration. This map defines the graph structure of the agent system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent (tools, instructions, sub-agents). - "a_key": { # Configuration for an Agent. - "agentId": "A String", # Optional. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. - "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. - "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. - "developerInstruction": { # Instance data used to populate placeholders in a metric prompt template. # Optional. Contains instructions from the developer for the agent. Can be static or a dynamic prompt template used with the `AgentEvent.state_delta` field. - "contents": { # List of standard Content messages from Gemini API. # List of Gemini content data. - "contents": [ # Optional. Repeated contents. - { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. - "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. - { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. - "outcome": "A String", # Required. Outcome of the code execution. - "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. - }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. - "code": "A String", # Required. The code to be executed. - "language": "A String", # Required. Programming language of the `code`. - }, - "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. - "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "functionCall": { # 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. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. - "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. - "a_key": "", # Properties of the object. - }, - "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. - "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. - "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. - { # Partial argument value of the function call. - "boolValue": True or False, # Optional. Represents a boolean value. - "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". - "nullValue": "A String", # Optional. Represents a null value. - "numberValue": 3.14, # Optional. Represents a double value. - "stringValue": "A String", # Optional. Represents a string value. - "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. - }, - ], - "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. - }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. - "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. - "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. - "fileData": { # URI based data for function response. # URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - }, - ], - "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. - "a_key": "", # Properties of the object. - }, - "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. - }, - "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. - "data": "A String", # Required. The raw bytes of the data. - "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. - "level": "A String", # The tokenization quality used for given media. - }, - "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. - "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. - "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. - "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. - "startOffset": "A String", # Optional. The start offset of the video. - }, - }, - ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. - }, - ], - }, - "text": "A String", # Text data. - }, - "subAgents": [ # Optional. The list of valid agent IDs (names) that this agent can delegate to. This defines the directed edges in the agent system graph topology. - "A String", - ], - "tools": { # Represents a list of tools for an agent. # List of tools. - "tool": [ # Optional. List of tools: each tool can have multiple function declarations. - { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). - "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. - }, - "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. - "environment": "A String", # Required. The environment being operated. - "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. - "A String", - ], - }, - "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. - "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. - "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. - "A String", - ], - }, - "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. - { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. - "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. - "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 - "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. - "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. - # Object with schema name: GoogleCloudAiplatformV1beta1Schema - ], - "default": "", # Optional. Default value to use if the field is not specified. - "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. - "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema - }, - "description": "A String", # Optional. Description of the schema. - "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` - "A String", - ], - "example": "", # Optional. Example of an instance of this schema. - "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. - "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. - "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. - "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. - "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. - "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. - "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. - "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. - "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. - "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. - "nullable": True or False, # Optional. Indicates if the value of this field can be null. - "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. - "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. - "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema - }, - "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. - "A String", - ], - "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring - "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. - "A String", - ], - "title": "A String", # Optional. Title for the schema. - "type": "A String", # Optional. Data type of the schema field. - }, - "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. - "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. - "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. - "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. - # Object with schema name: GoogleCloudAiplatformV1beta1Schema - ], - "default": "", # Optional. Default value to use if the field is not specified. - "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. - "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema - }, - "description": "A String", # Optional. Description of the schema. - "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` - "A String", - ], - "example": "", # Optional. Example of an instance of this schema. - "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. - "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. - "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. - "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. - "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. - "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. - "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. - "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. - "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. - "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. - "nullable": True or False, # Optional. Indicates if the value of this field can be null. - "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. - "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. - "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema - }, - "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. - "A String", - ], - "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring - "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. - "A String", - ], - "title": "A String", # Optional. Title for the schema. - "type": "A String", # Optional. Data type of the schema field. - }, - "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. - }, - ], - "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. - "enableWidget": True or False, # Optional. If true, include the widget context token in the response. - }, - "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. - "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. - "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. - "A String", - ], - }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. - "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. - "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. - "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. - }, - }, - "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation - "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. - "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } - "a_key": "", # Properties of the object. - }, - }, - "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. - "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. - "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. - "apiKeyConfig": { # The API secret. # The API secret. - "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} - "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. - }, - }, - "apiSpec": "A String", # The API spec that the external API implements. - "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. - "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. - "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. - "apiKeyString": "A String", # Optional. The API key to be used in the request directly. - "httpElementLocation": "A String", # Optional. The location of the API key. - "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. - }, - "authType": "A String", # Type of auth scheme. - "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. - "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. - }, - "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. - "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. - }, - "oauthConfig": { # Config for user oauth. # Config for user oauth. - "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. - "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. - }, - "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. - "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. - "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). - }, - }, - "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. - "index": "A String", # The ElasticSearch index to use. - "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. - "searchTemplate": "A String", # The ElasticSearch search template to use. - }, - "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search - "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. - }, - }, - "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. - "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. - { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec - "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` - "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) - }, - ], - "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` - "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` - "filter": "A String", # Optional. Filter strings to be passed to the search API. - "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. - }, - "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. - "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. - "A String", - ], - "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. - { # The definition of the Rag resource. - "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` - "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", - ], - }, - ], - "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. - "filter": { # Config for filters. # Optional. Config for filters. - "metadataFilter": "A String", # Optional. String for metadata filtering. - "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. - "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. - }, - "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. - "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. - }, - "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. - "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. - "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). - }, - "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. - "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` - }, - }, - "topK": 42, # Optional. The number of contexts to retrieve. - }, - "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. - "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. - "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. - }, - }, - "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. - }, - }, - ], - }, - "toolsText": "A String", # A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters. - }, - }, - "developerInstruction": { # Instance data used to populate placeholders in a metric prompt template. # Optional. Deprecated. A field containing instructions from the developer for the agent. Please use `agents.developer_instruction` or `turns.events.active_instruction` instead. - "contents": { # List of standard Content messages from Gemini API. # List of Gemini content data. - "contents": [ # Optional. Repeated contents. - { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. - "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. - { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. - "outcome": "A String", # Required. Outcome of the code execution. - "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. - }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. - "code": "A String", # Required. The code to be executed. - "language": "A String", # Required. Programming language of the `code`. - }, - "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. - "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "functionCall": { # 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. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. - "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. - "a_key": "", # Properties of the object. - }, - "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. - "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. - "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. - { # Partial argument value of the function call. - "boolValue": True or False, # Optional. Represents a boolean value. - "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". - "nullValue": "A String", # Optional. Represents a null value. - "numberValue": 3.14, # Optional. Represents a double value. - "stringValue": "A String", # Optional. Represents a string value. - "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. - }, - ], - "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. - }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. - "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. - "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. - "fileData": { # URI based data for function response. # URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - }, - ], - "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. - "a_key": "", # Properties of the object. - }, - "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. - }, - "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. - "data": "A String", # Required. The raw bytes of the data. - "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. - "level": "A String", # The tokenization quality used for given media. - }, - "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. - "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. - "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. - "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. - "startOffset": "A String", # Optional. The start offset of the video. - }, - }, - ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. - }, - ], - }, - "text": "A String", # Text data. - }, - "events": { # Represents a list of events for an agent. # A list of events. - "event": [ # Optional. A list of events. - { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. - "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. - { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. - "outcome": "A String", # Required. Outcome of the code execution. - "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. - }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. - "code": "A String", # Required. The code to be executed. - "language": "A String", # Required. Programming language of the `code`. - }, - "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. - "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "functionCall": { # 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. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. - "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. - "a_key": "", # Properties of the object. - }, - "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. - "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. - "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. - { # Partial argument value of the function call. - "boolValue": True or False, # Optional. Represents a boolean value. - "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". - "nullValue": "A String", # Optional. Represents a null value. - "numberValue": 3.14, # Optional. Represents a double value. - "stringValue": "A String", # Optional. Represents a string value. - "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. - }, - ], - "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. - }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. - "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. - "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. - "fileData": { # URI based data for function response. # URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - }, - ], - "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. - "a_key": "", # Properties of the object. - }, - "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. - }, - "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. - "data": "A String", # Required. The raw bytes of the data. - "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. - "level": "A String", # The tokenization quality used for given media. - }, - "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. - "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. - "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. - "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. - "startOffset": "A String", # Optional. The start offset of the video. - }, - }, - ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. - }, - ], - }, - "tools": { # Deprecated. Represents a list of tools for an agent. # List of tools. - "tool": [ # Optional. List of tools: each tool can have multiple function declarations. - { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). - "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. - }, - "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. - "environment": "A String", # Required. The environment being operated. - "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. - "A String", - ], - }, - "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. - "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. - "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. - "A String", - ], - }, - "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. - { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. - "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. - "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 - "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. - "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. - # Object with schema name: GoogleCloudAiplatformV1beta1Schema - ], - "default": "", # Optional. Default value to use if the field is not specified. - "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. - "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema - }, - "description": "A String", # Optional. Description of the schema. - "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` - "A String", - ], - "example": "", # Optional. Example of an instance of this schema. - "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. - "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. - "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. - "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. - "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. - "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. - "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. - "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. - "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. - "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. - "nullable": True or False, # Optional. Indicates if the value of this field can be null. - "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. - "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. - "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema - }, - "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. - "A String", - ], - "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring - "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. - "A String", - ], - "title": "A String", # Optional. Title for the schema. - "type": "A String", # Optional. Data type of the schema field. - }, - "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. - "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. - "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. - "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. - # Object with schema name: GoogleCloudAiplatformV1beta1Schema - ], - "default": "", # Optional. Default value to use if the field is not specified. - "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. - "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema - }, - "description": "A String", # Optional. Description of the schema. - "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` - "A String", - ], - "example": "", # Optional. Example of an instance of this schema. - "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. - "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. - "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. - "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. - "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. - "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. - "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. - "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. - "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. - "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. - "nullable": True or False, # Optional. Indicates if the value of this field can be null. - "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. - "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. - "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. }, - "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. - "A String", - ], - "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring - "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. - "A String", - ], - "title": "A String", # Optional. Title for the schema. - "type": "A String", # Optional. Data type of the schema field. + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. }, - "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. - }, - ], - "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. - "enableWidget": True or False, # Optional. If true, include the widget context token in the response. - }, - "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. - "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. - "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. - "A String", ], - }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. - "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. - "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. - "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. - }, - }, - "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation - "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. - "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } - "a_key": "", # Properties of the object. + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, - }, - "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. - "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. - "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. - "apiKeyConfig": { # The API secret. # The API secret. - "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} - "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. - }, - }, - "apiSpec": "A String", # The API spec that the external API implements. - "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. - "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. - "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. - "apiKeyString": "A String", # Optional. The API key to be used in the request directly. - "httpElementLocation": "A String", # Optional. The location of the API key. - "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. - }, - "authType": "A String", # Type of auth scheme. - "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. - "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. - }, - "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. - "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. - }, - "oauthConfig": { # Config for user oauth. # Config for user oauth. - "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. - "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. }, - "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. - "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. - "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. }, }, - "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. - "index": "A String", # The ElasticSearch index to use. - "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. - "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. }, - "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search - "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. + "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } + "a_key": "", # Properties of the object. }, }, - "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. - "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. - { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec - "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` - "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, }, - ], - "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` - "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` - "filter": "A String", # Optional. Filter strings to be passed to the search API. - "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. - }, - "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. - "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. - "A String", - ], - "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. - { # The definition of the Rag resource. - "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` - "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", - ], + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, }, - ], - "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. - "filter": { # Config for filters. # Optional. Config for filters. - "metadataFilter": "A String", # Optional. String for metadata filtering. - "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. - "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. }, - "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. - "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. }, - "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. - "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. - "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) }, - "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. - "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. + "A String", + ], + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, }, + "topK": 42, # Optional. The number of contexts to retrieve. }, - "topK": 42, # Optional. The number of contexts to retrieve. + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, - "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. - "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. - "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. }, }, - "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. - }, - }, - ], + ], + }, }, - "toolsText": "A String", # A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters. - "turns": [ # Optional. The chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). + "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). { # Represents a single turn/invocation in the conversation. "events": [ # Optional. The list of events that occurred during this turn. - { # A single event in the execution trace. + { # Represents a single event in the execution trace. "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. @@ -4109,7 +3953,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -4149,7 +3993,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -4190,6 +4034,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -4297,7 +4147,7 @@

Method Details

}, }, ], - "author": "A String", # Required. The ID of the agent or entity that generated this event. + "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. @@ -4780,6 +4630,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -4803,7 +4654,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -4908,6 +4759,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -4931,7 +4783,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -5825,7 +5677,7 @@

Method Details

The object takes the form of: { # Request message for EvaluationService.GenerateInstanceRubrics. - "agentConfig": { # Configuration for an Agent. # Optional. Agent configuration, required for agent-based rubric generation. + "agentConfig": { # Deprecated: Use `google.cloud.aiplatform.master.AgentConfig` in `agent_eval_data` instead. Configuration for an Agent. # Optional. Agent configuration, required for agent-based rubric generation. "agentId": "A String", # Optional. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. @@ -5945,7 +5797,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -5985,7 +5837,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -6026,6 +5878,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -6238,6 +6096,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -6261,7 +6120,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html index d41e12023c..a545d7029d 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html @@ -351,6 +351,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -374,7 +375,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -562,7 +563,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -602,7 +603,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -643,6 +644,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -782,8 +789,8 @@

Method Details

The object takes the form of: { # Request message for PredictionService.EmbedContent. - "autoTruncate": True or False, # Optional. Whether to silently truncate the input content if it's longer than the maximum sequence length. - "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. Input content to be embedded. Required. + "autoTruncate": True or False, # Optional. Deprecated: Please use EmbedContentConfig.auto_truncate instead. Whether to silently truncate the input content if it's longer than the maximum sequence length. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content to be embedded. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. @@ -859,9 +866,9 @@

Method Details

], "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, - "outputDimensionality": 42, # Optional. Optional reduced dimension for the output embedding. If set, excessive values in the output embedding are truncated from the end. - "taskType": "A String", # Optional. The task type of the embedding. - "title": "A String", # Optional. An optional title for the text. + "outputDimensionality": 42, # Optional. Deprecated: Please use EmbedContentConfig.output_dimensionality instead. Reduced dimension for the output embedding. If set, excessive values in the output embedding are truncated from the end. + "taskType": "A String", # Optional. Deprecated: Please use EmbedContentConfig.task_type instead. The task type of the embedding. + "title": "A String", # Optional. Deprecated: Please use EmbedContentConfig.title instead. The title for the text. } x__xgafv: string, V1 error format. @@ -879,7 +886,7 @@

Method Details

], }, "truncated": True or False, # Whether the input content was truncated before generating the embedding. - "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Metadata about the response(s). + "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s). "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content. { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. "modality": "A String", # The modality that this token count applies to. @@ -1132,6 +1139,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -1155,7 +1163,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1369,7 +1377,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1409,7 +1417,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1450,6 +1458,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -1669,6 +1683,12 @@

Method Details

"googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps. { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information. + "image": { # An `Image` chunk is a piece of evidence that comes from an image search result. It contains the URI of the image search result and the URI of the image. This is used to provide the user with a link to the source of the information. # A grounding chunk from an image search result. See the `Image` message for details. + "domain": "A String", # The domain of the image search result page. + "imageUri": "A String", # The URI of the image. + "sourceUri": "A String", # The URI of the image search result page. + "title": "A String", # The title of the image search result page. + }, "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps, containing information about places or routes. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details. "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. "reviewSnippets": [ # Snippets of reviews that were used to generate the answer. @@ -1680,6 +1700,11 @@

Method Details

], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API. + "route": { # Route information from Google Maps. # Output only. Route information. + "distanceMeters": 42, # The total distance of the route, in meters. + "duration": "A String", # The total duration of the route. + "encodedPolyline": "A String", # An encoded polyline of the route. See https://developers.google.com/maps/documentation/utilities/polylinealgorithm + }, "text": "A String", # The text of the place answer. "title": "A String", # The title of the place. "uri": "A String", # The URI of the place. @@ -1705,13 +1730,16 @@

Method Details

}, ], "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search. - { # A collection of supporting references for a segment of the model's response. + { # A collection of supporting references for a segment or part of the model's response. "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored. 3.14, ], "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment. 42, ], + "renderedParts": [ # Indices into the `rendered_parts` field of the `GroundingMetadata` message. These indices specify which rendered parts are associated with this support message. + 42, + ], "segment": { # A segment of the content. # The content segment that this support message applies to. "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index. "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content. @@ -1720,6 +1748,9 @@

Method Details

}, }, ], + "imageSearchQueries": [ # Optional. The image search queries that were used to generate the content. This field is populated only when the grounding source is Google Search with the Image Search search_type enabled. + "A String", + ], "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, @@ -2338,6 +2369,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -2361,7 +2393,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2575,7 +2607,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2615,7 +2647,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2656,6 +2688,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -2875,6 +2913,12 @@

Method Details

"googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps. { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information. + "image": { # An `Image` chunk is a piece of evidence that comes from an image search result. It contains the URI of the image search result and the URI of the image. This is used to provide the user with a link to the source of the information. # A grounding chunk from an image search result. See the `Image` message for details. + "domain": "A String", # The domain of the image search result page. + "imageUri": "A String", # The URI of the image. + "sourceUri": "A String", # The URI of the image search result page. + "title": "A String", # The title of the image search result page. + }, "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps, containing information about places or routes. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details. "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. "reviewSnippets": [ # Snippets of reviews that were used to generate the answer. @@ -2886,6 +2930,11 @@

Method Details

], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API. + "route": { # Route information from Google Maps. # Output only. Route information. + "distanceMeters": 42, # The total distance of the route, in meters. + "duration": "A String", # The total duration of the route. + "encodedPolyline": "A String", # An encoded polyline of the route. See https://developers.google.com/maps/documentation/utilities/polylinealgorithm + }, "text": "A String", # The text of the place answer. "title": "A String", # The title of the place. "uri": "A String", # The URI of the place. @@ -2911,13 +2960,16 @@

Method Details

}, ], "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search. - { # A collection of supporting references for a segment of the model's response. + { # A collection of supporting references for a segment or part of the model's response. "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored. 3.14, ], "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment. 42, ], + "renderedParts": [ # Indices into the `rendered_parts` field of the `GroundingMetadata` message. These indices specify which rendered parts are associated with this support message. + 42, + ], "segment": { # A segment of the content. # The content segment that this support message applies to. "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index. "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content. @@ -2926,6 +2978,9 @@

Method Details

}, }, ], + "imageSearchQueries": [ # Optional. The image search queries that were used to generate the content. This field is populated only when the grounding source is Google Search with the Image Search search_type enabled. + "A String", + ], "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.ragFiles.html b/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.ragFiles.html index 1092b8c825..10a9cce069 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.ragFiles.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.ragFiles.html @@ -306,7 +306,7 @@

Method Details

"chunkSize": 42, # The size of the chunks. }, }, - "ragFileMetadataConfig": { # Metadata config for RagFile. # Specifies the metadata config for RagFiles. Including paths for metadata schema and metadata. + "ragFileMetadataConfig": { # Metadata config for RagFile. # Specifies the metadata config for RagFiles. Including paths for metadata schema and metadata. Deprecated: Not in use. "gcsMetadataSchemaSource": { # The Google Cloud Storage location for the input content. # Google Cloud Storage location. Supports importing individual files as well as entire Google Cloud Storage directories. Sample formats: - `gs://bucket_name/my_directory/object_name/metadata_schema.json` - `gs://bucket_name/my_directory` If the user provides a directory, the metadata schema will be read from the files that ends with "metadata_schema.json" in the directory. "uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards. "A String", diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html index b4f663a269..2c6a028a3a 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html @@ -213,6 +213,12 @@

Method Details

"googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps. { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information. + "image": { # An `Image` chunk is a piece of evidence that comes from an image search result. It contains the URI of the image search result and the URI of the image. This is used to provide the user with a link to the source of the information. # A grounding chunk from an image search result. See the `Image` message for details. + "domain": "A String", # The domain of the image search result page. + "imageUri": "A String", # The URI of the image. + "sourceUri": "A String", # The URI of the image search result page. + "title": "A String", # The title of the image search result page. + }, "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps, containing information about places or routes. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details. "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. "reviewSnippets": [ # Snippets of reviews that were used to generate the answer. @@ -224,6 +230,11 @@

Method Details

], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API. + "route": { # Route information from Google Maps. # Output only. Route information. + "distanceMeters": 42, # The total distance of the route, in meters. + "duration": "A String", # The total duration of the route. + "encodedPolyline": "A String", # An encoded polyline of the route. See https://developers.google.com/maps/documentation/utilities/polylinealgorithm + }, "text": "A String", # The text of the place answer. "title": "A String", # The title of the place. "uri": "A String", # The URI of the place. @@ -249,13 +260,16 @@

Method Details

}, ], "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search. - { # A collection of supporting references for a segment of the model's response. + { # A collection of supporting references for a segment or part of the model's response. "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored. 3.14, ], "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment. 42, ], + "renderedParts": [ # Indices into the `rendered_parts` field of the `GroundingMetadata` message. These indices specify which rendered parts are associated with this support message. + 42, + ], "segment": { # A segment of the content. # The content segment that this support message applies to. "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index. "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content. @@ -264,6 +278,9 @@

Method Details

}, }, ], + "imageSearchQueries": [ # Optional. The image search queries that were used to generate the content. This field is populated only when the grounding source is Google Search with the Image Search search_type enabled. + "A String", + ], "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, @@ -284,10 +301,18 @@

Method Details

"A String", ], }, + "inputTranscription": { # Audio transcription in Server Content. # Optional. Audio transcription of user input. + "finished": True or False, # Optional. The bool indicates the end of the transcription. + "text": "A String", # Optional. Transcription text. + }, "interrupted": True or False, # Optional. Flag indicating that LLM was interrupted when generating the content. Usually it's due to user interruption during a bidi streaming. "longRunningToolIds": [ # Optional. Set of ids of the long running function calls. Agent client will know from this field about which function call is long running. Only valid for function call event. "A String", ], + "outputTranscription": { # Audio transcription in Server Content. # Optional. Audio transcription of model output. + "finished": True or False, # Optional. The bool indicates the end of the transcription. + "text": "A String", # Optional. Transcription text. + }, "partial": True or False, # Optional. Indicates whether the text content is part of a unfinished text stream. Only used for streaming mode and when the content is plain text. "turnComplete": True or False, # Optional. Indicates whether the response from the model is complete. Only used for streaming mode. }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html index 1c86830009..c7bc9fb403 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html @@ -221,6 +221,12 @@

Method Details

"googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps. { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information. + "image": { # An `Image` chunk is a piece of evidence that comes from an image search result. It contains the URI of the image search result and the URI of the image. This is used to provide the user with a link to the source of the information. # A grounding chunk from an image search result. See the `Image` message for details. + "domain": "A String", # The domain of the image search result page. + "imageUri": "A String", # The URI of the image. + "sourceUri": "A String", # The URI of the image search result page. + "title": "A String", # The title of the image search result page. + }, "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps, containing information about places or routes. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details. "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. "reviewSnippets": [ # Snippets of reviews that were used to generate the answer. @@ -232,6 +238,11 @@

Method Details

], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API. + "route": { # Route information from Google Maps. # Output only. Route information. + "distanceMeters": 42, # The total distance of the route, in meters. + "duration": "A String", # The total duration of the route. + "encodedPolyline": "A String", # An encoded polyline of the route. See https://developers.google.com/maps/documentation/utilities/polylinealgorithm + }, "text": "A String", # The text of the place answer. "title": "A String", # The title of the place. "uri": "A String", # The URI of the place. @@ -257,13 +268,16 @@

Method Details

}, ], "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search. - { # A collection of supporting references for a segment of the model's response. + { # A collection of supporting references for a segment or part of the model's response. "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored. 3.14, ], "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment. 42, ], + "renderedParts": [ # Indices into the `rendered_parts` field of the `GroundingMetadata` message. These indices specify which rendered parts are associated with this support message. + 42, + ], "segment": { # A segment of the content. # The content segment that this support message applies to. "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index. "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content. @@ -272,6 +286,9 @@

Method Details

}, }, ], + "imageSearchQueries": [ # Optional. The image search queries that were used to generate the content. This field is populated only when the grounding source is Google Search with the Image Search search_type enabled. + "A String", + ], "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, @@ -292,10 +309,18 @@

Method Details

"A String", ], }, + "inputTranscription": { # Audio transcription in Server Content. # Optional. Audio transcription of user input. + "finished": True or False, # Optional. The bool indicates the end of the transcription. + "text": "A String", # Optional. Transcription text. + }, "interrupted": True or False, # Optional. Flag indicating that LLM was interrupted when generating the content. Usually it's due to user interruption during a bidi streaming. "longRunningToolIds": [ # Optional. Set of ids of the long running function calls. Agent client will know from this field about which function call is long running. Only valid for function call event. "A String", ], + "outputTranscription": { # Audio transcription in Server Content. # Optional. Audio transcription of model output. + "finished": True or False, # Optional. The bool indicates the end of the transcription. + "text": "A String", # Optional. Transcription text. + }, "partial": True or False, # Optional. Indicates whether the text content is part of a unfinished text stream. Only used for streaming mode and when the content is plain text. "turnComplete": True or False, # Optional. Indicates whether the response from the model is complete. Only used for streaming mode. }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html index 186a31c8d7..350013204e 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html @@ -147,6 +147,11 @@

Method Details

"createTime": "A String", # Output only. Time when the TuningJob was created. "customBaseModel": "A String", # Optional. The user-provided path to custom model weights. Set this field to tune a custom model. The path must be a Cloud Storage directory that contains the model weights in .safetensors format along with associated model metadata files. If this field is set, the base_model field must still be set to indicate which base model the custom model is derived from. This feature is only available for open source models. "description": "A String", # Optional. The description of the TuningJob. + "distillationSamplingSpec": { # Spec for creating a distilled dataset in Vertex Dataset. # Optional. Spec for creating a distillation dataset. + "baseTeacherModel": "A String", # Optional. The base teacher model that is being distilled. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models). + "tunedTeacherModelSource": "A String", # Optional. The resource name of the Tuned teacher model. Format: `projects/{project}/locations/{location}/models/{model}`. + "validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for distillation. The dataset must be formatted as a JSONL file. + }, "distillationSpec": { # Tuning Spec for Distillation. # Tuning Spec for Distillation. "baseTeacherModel": "A String", # The base teacher model that is being distilled. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models). "hyperParameters": { # Hyperparameters for Distillation. # Optional. Hyperparameters for Distillation. @@ -242,7 +247,7 @@

Method Details

}, }, "evaluationRun": "A String", # Output only. The resource name of the evaluation run. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run_id}`. - "operationName": "A String", # Output only. The operation ID of the evaluation run. Format: `projects/{project}/locations/{location}/operations/{operation_id}`. + "operationName": "A String", # Output only. Deprecated: The updated architecture uses evaluation_run instead. }, ], "experiment": "A String", # Output only. The Experiment associated with this TuningJob. @@ -309,6 +314,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -332,7 +338,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -426,6 +432,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -449,7 +456,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -567,6 +574,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -590,7 +598,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -695,6 +703,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -718,7 +727,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1391,6 +1400,10 @@

Method Details

}, }, }, + "tuningJobMetadata": { # Tuning job metadata. # Output only. Tuning Job metadata. + "completedEpochCount": "A String", # Output only. The number of epochs that have been completed. + "completedStepCount": "A String", # Output only. The number of steps that have been completed. Set for Multi-Step RL. + }, "tuningJobState": "A String", # Output only. The detail state of the tuning job (while the overall `JobState` is running). "updateTime": "A String", # Output only. Time when the TuningJob was most recently updated. "veoTuningSpec": { # Tuning Spec for Veo Model Tuning. # Tuning Spec for Veo Tuning. @@ -1418,6 +1431,11 @@

Method Details

"createTime": "A String", # Output only. Time when the TuningJob was created. "customBaseModel": "A String", # Optional. The user-provided path to custom model weights. Set this field to tune a custom model. The path must be a Cloud Storage directory that contains the model weights in .safetensors format along with associated model metadata files. If this field is set, the base_model field must still be set to indicate which base model the custom model is derived from. This feature is only available for open source models. "description": "A String", # Optional. The description of the TuningJob. + "distillationSamplingSpec": { # Spec for creating a distilled dataset in Vertex Dataset. # Optional. Spec for creating a distillation dataset. + "baseTeacherModel": "A String", # Optional. The base teacher model that is being distilled. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models). + "tunedTeacherModelSource": "A String", # Optional. The resource name of the Tuned teacher model. Format: `projects/{project}/locations/{location}/models/{model}`. + "validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for distillation. The dataset must be formatted as a JSONL file. + }, "distillationSpec": { # Tuning Spec for Distillation. # Tuning Spec for Distillation. "baseTeacherModel": "A String", # The base teacher model that is being distilled. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models). "hyperParameters": { # Hyperparameters for Distillation. # Optional. Hyperparameters for Distillation. @@ -1513,7 +1531,7 @@

Method Details

}, }, "evaluationRun": "A String", # Output only. The resource name of the evaluation run. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run_id}`. - "operationName": "A String", # Output only. The operation ID of the evaluation run. Format: `projects/{project}/locations/{location}/operations/{operation_id}`. + "operationName": "A String", # Output only. Deprecated: The updated architecture uses evaluation_run instead. }, ], "experiment": "A String", # Output only. The Experiment associated with this TuningJob. @@ -1580,6 +1598,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -1603,7 +1622,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1697,6 +1716,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -1720,7 +1740,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1838,6 +1858,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -1861,7 +1882,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1966,6 +1987,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -1989,7 +2011,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2662,6 +2684,10 @@

Method Details

}, }, }, + "tuningJobMetadata": { # Tuning job metadata. # Output only. Tuning Job metadata. + "completedEpochCount": "A String", # Output only. The number of epochs that have been completed. + "completedStepCount": "A String", # Output only. The number of steps that have been completed. Set for Multi-Step RL. + }, "tuningJobState": "A String", # Output only. The detail state of the tuning job (while the overall `JobState` is running). "updateTime": "A String", # Output only. Time when the TuningJob was most recently updated. "veoTuningSpec": { # Tuning Spec for Veo Model Tuning. # Tuning Spec for Veo Tuning. @@ -2696,6 +2722,11 @@

Method Details

"createTime": "A String", # Output only. Time when the TuningJob was created. "customBaseModel": "A String", # Optional. The user-provided path to custom model weights. Set this field to tune a custom model. The path must be a Cloud Storage directory that contains the model weights in .safetensors format along with associated model metadata files. If this field is set, the base_model field must still be set to indicate which base model the custom model is derived from. This feature is only available for open source models. "description": "A String", # Optional. The description of the TuningJob. + "distillationSamplingSpec": { # Spec for creating a distilled dataset in Vertex Dataset. # Optional. Spec for creating a distillation dataset. + "baseTeacherModel": "A String", # Optional. The base teacher model that is being distilled. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models). + "tunedTeacherModelSource": "A String", # Optional. The resource name of the Tuned teacher model. Format: `projects/{project}/locations/{location}/models/{model}`. + "validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for distillation. The dataset must be formatted as a JSONL file. + }, "distillationSpec": { # Tuning Spec for Distillation. # Tuning Spec for Distillation. "baseTeacherModel": "A String", # The base teacher model that is being distilled. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models). "hyperParameters": { # Hyperparameters for Distillation. # Optional. Hyperparameters for Distillation. @@ -2791,7 +2822,7 @@

Method Details

}, }, "evaluationRun": "A String", # Output only. The resource name of the evaluation run. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run_id}`. - "operationName": "A String", # Output only. The operation ID of the evaluation run. Format: `projects/{project}/locations/{location}/operations/{operation_id}`. + "operationName": "A String", # Output only. Deprecated: The updated architecture uses evaluation_run instead. }, ], "experiment": "A String", # Output only. The Experiment associated with this TuningJob. @@ -2858,6 +2889,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -2881,7 +2913,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2975,6 +3007,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -2998,7 +3031,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -3116,6 +3149,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -3139,7 +3173,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -3244,6 +3278,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -3267,7 +3302,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -3940,6 +3975,10 @@

Method Details

}, }, }, + "tuningJobMetadata": { # Tuning job metadata. # Output only. Tuning Job metadata. + "completedEpochCount": "A String", # Output only. The number of epochs that have been completed. + "completedStepCount": "A String", # Output only. The number of steps that have been completed. Set for Multi-Step RL. + }, "tuningJobState": "A String", # Output only. The detail state of the tuning job (while the overall `JobState` is running). "updateTime": "A String", # Output only. Time when the TuningJob was most recently updated. "veoTuningSpec": { # Tuning Spec for Veo Model Tuning. # Tuning Spec for Veo Tuning. @@ -3980,6 +4019,11 @@

Method Details

"createTime": "A String", # Output only. Time when the TuningJob was created. "customBaseModel": "A String", # Optional. The user-provided path to custom model weights. Set this field to tune a custom model. The path must be a Cloud Storage directory that contains the model weights in .safetensors format along with associated model metadata files. If this field is set, the base_model field must still be set to indicate which base model the custom model is derived from. This feature is only available for open source models. "description": "A String", # Optional. The description of the TuningJob. + "distillationSamplingSpec": { # Spec for creating a distilled dataset in Vertex Dataset. # Optional. Spec for creating a distillation dataset. + "baseTeacherModel": "A String", # Optional. The base teacher model that is being distilled. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models). + "tunedTeacherModelSource": "A String", # Optional. The resource name of the Tuned teacher model. Format: `projects/{project}/locations/{location}/models/{model}`. + "validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for distillation. The dataset must be formatted as a JSONL file. + }, "distillationSpec": { # Tuning Spec for Distillation. # Tuning Spec for Distillation. "baseTeacherModel": "A String", # The base teacher model that is being distilled. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models). "hyperParameters": { # Hyperparameters for Distillation. # Optional. Hyperparameters for Distillation. @@ -4075,7 +4119,7 @@

Method Details

}, }, "evaluationRun": "A String", # Output only. The resource name of the evaluation run. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run_id}`. - "operationName": "A String", # Output only. The operation ID of the evaluation run. Format: `projects/{project}/locations/{location}/operations/{operation_id}`. + "operationName": "A String", # Output only. Deprecated: The updated architecture uses evaluation_run instead. }, ], "experiment": "A String", # Output only. The Experiment associated with this TuningJob. @@ -4142,6 +4186,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -4165,7 +4210,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -4259,6 +4304,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -4282,7 +4328,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -4400,6 +4446,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -4423,7 +4470,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -4528,6 +4575,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -4551,7 +4599,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -5224,6 +5272,10 @@

Method Details

}, }, }, + "tuningJobMetadata": { # Tuning job metadata. # Output only. Tuning Job metadata. + "completedEpochCount": "A String", # Output only. The number of epochs that have been completed. + "completedStepCount": "A String", # Output only. The number of steps that have been completed. Set for Multi-Step RL. + }, "tuningJobState": "A String", # Output only. The detail state of the tuning job (while the overall `JobState` is running). "updateTime": "A String", # Output only. Time when the TuningJob was most recently updated. "veoTuningSpec": { # Tuning Spec for Veo Model Tuning. # Tuning Spec for Veo Tuning. @@ -5456,6 +5508,11 @@

Method Details

"createTime": "A String", # Output only. Time when the TuningJob was created. "customBaseModel": "A String", # Optional. The user-provided path to custom model weights. Set this field to tune a custom model. The path must be a Cloud Storage directory that contains the model weights in .safetensors format along with associated model metadata files. If this field is set, the base_model field must still be set to indicate which base model the custom model is derived from. This feature is only available for open source models. "description": "A String", # Optional. The description of the TuningJob. + "distillationSamplingSpec": { # Spec for creating a distilled dataset in Vertex Dataset. # Optional. Spec for creating a distillation dataset. + "baseTeacherModel": "A String", # Optional. The base teacher model that is being distilled. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models). + "tunedTeacherModelSource": "A String", # Optional. The resource name of the Tuned teacher model. Format: `projects/{project}/locations/{location}/models/{model}`. + "validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for distillation. The dataset must be formatted as a JSONL file. + }, "distillationSpec": { # Tuning Spec for Distillation. # Tuning Spec for Distillation. "baseTeacherModel": "A String", # The base teacher model that is being distilled. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models). "hyperParameters": { # Hyperparameters for Distillation. # Optional. Hyperparameters for Distillation. @@ -5551,7 +5608,7 @@

Method Details

}, }, "evaluationRun": "A String", # Output only. The resource name of the evaluation run. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run_id}`. - "operationName": "A String", # Output only. The operation ID of the evaluation run. Format: `projects/{project}/locations/{location}/operations/{operation_id}`. + "operationName": "A String", # Output only. Deprecated: The updated architecture uses evaluation_run instead. }, ], "experiment": "A String", # Output only. The Experiment associated with this TuningJob. @@ -5618,6 +5675,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -5641,7 +5699,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -5735,6 +5793,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -5758,7 +5817,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -5876,6 +5935,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -5899,7 +5959,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -6004,6 +6064,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -6027,7 +6088,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -6700,6 +6761,10 @@

Method Details

}, }, }, + "tuningJobMetadata": { # Tuning job metadata. # Output only. Tuning Job metadata. + "completedEpochCount": "A String", # Output only. The number of epochs that have been completed. + "completedStepCount": "A String", # Output only. The number of steps that have been completed. Set for Multi-Step RL. + }, "tuningJobState": "A String", # Output only. The detail state of the tuning job (while the overall `JobState` is running). "updateTime": "A String", # Output only. Time when the TuningJob was most recently updated. "veoTuningSpec": { # Tuning Spec for Veo Model Tuning. # Tuning Spec for Veo Tuning. diff --git a/docs/dyn/aiplatform_v1beta1.publishers.models.html b/docs/dyn/aiplatform_v1beta1.publishers.models.html index 4c5a656de0..e8eb79e1fb 100644 --- a/docs/dyn/aiplatform_v1beta1.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.publishers.models.html @@ -331,6 +331,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -354,7 +355,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -542,7 +543,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -582,7 +583,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -623,6 +624,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -896,6 +903,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -919,7 +927,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1133,7 +1141,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1173,7 +1181,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1214,6 +1222,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -1433,6 +1447,12 @@

Method Details

"googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps. { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information. + "image": { # An `Image` chunk is a piece of evidence that comes from an image search result. It contains the URI of the image search result and the URI of the image. This is used to provide the user with a link to the source of the information. # A grounding chunk from an image search result. See the `Image` message for details. + "domain": "A String", # The domain of the image search result page. + "imageUri": "A String", # The URI of the image. + "sourceUri": "A String", # The URI of the image search result page. + "title": "A String", # The title of the image search result page. + }, "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps, containing information about places or routes. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details. "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. "reviewSnippets": [ # Snippets of reviews that were used to generate the answer. @@ -1444,6 +1464,11 @@

Method Details

], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API. + "route": { # Route information from Google Maps. # Output only. Route information. + "distanceMeters": 42, # The total distance of the route, in meters. + "duration": "A String", # The total duration of the route. + "encodedPolyline": "A String", # An encoded polyline of the route. See https://developers.google.com/maps/documentation/utilities/polylinealgorithm + }, "text": "A String", # The text of the place answer. "title": "A String", # The title of the place. "uri": "A String", # The URI of the place. @@ -1469,13 +1494,16 @@

Method Details

}, ], "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search. - { # A collection of supporting references for a segment of the model's response. + { # A collection of supporting references for a segment or part of the model's response. "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored. 3.14, ], "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment. 42, ], + "renderedParts": [ # Indices into the `rendered_parts` field of the `GroundingMetadata` message. These indices specify which rendered parts are associated with this support message. + 42, + ], "segment": { # A segment of the content. # The content segment that this support message applies to. "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index. "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content. @@ -1484,6 +1512,9 @@

Method Details

}, }, ], + "imageSearchQueries": [ # Optional. The image search queries that were used to generate the content. This field is populated only when the grounding source is Google Search with the Image Search search_type enabled. + "A String", + ], "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, @@ -3029,6 +3060,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -3052,7 +3084,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -3266,7 +3298,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -3306,7 +3338,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -3347,6 +3379,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -3566,6 +3604,12 @@

Method Details

"googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps. { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information. + "image": { # An `Image` chunk is a piece of evidence that comes from an image search result. It contains the URI of the image search result and the URI of the image. This is used to provide the user with a link to the source of the information. # A grounding chunk from an image search result. See the `Image` message for details. + "domain": "A String", # The domain of the image search result page. + "imageUri": "A String", # The URI of the image. + "sourceUri": "A String", # The URI of the image search result page. + "title": "A String", # The title of the image search result page. + }, "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps, containing information about places or routes. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details. "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. "reviewSnippets": [ # Snippets of reviews that were used to generate the answer. @@ -3577,6 +3621,11 @@

Method Details

], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API. + "route": { # Route information from Google Maps. # Output only. Route information. + "distanceMeters": 42, # The total distance of the route, in meters. + "duration": "A String", # The total duration of the route. + "encodedPolyline": "A String", # An encoded polyline of the route. See https://developers.google.com/maps/documentation/utilities/polylinealgorithm + }, "text": "A String", # The text of the place answer. "title": "A String", # The title of the place. "uri": "A String", # The URI of the place. @@ -3602,13 +3651,16 @@

Method Details

}, ], "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search. - { # A collection of supporting references for a segment of the model's response. + { # A collection of supporting references for a segment or part of the model's response. "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored. 3.14, ], "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment. 42, ], + "renderedParts": [ # Indices into the `rendered_parts` field of the `GroundingMetadata` message. These indices specify which rendered parts are associated with this support message. + 42, + ], "segment": { # A segment of the content. # The content segment that this support message applies to. "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index. "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content. @@ -3617,6 +3669,9 @@

Method Details

}, }, ], + "imageSearchQueries": [ # Optional. The image search queries that were used to generate the content. This field is populated only when the grounding source is Google Search with the Image Search search_type enabled. + "A String", + ], "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html index 35d1445f28..2189cfd24c 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html @@ -213,6 +213,12 @@

Method Details

"googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps. { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information. + "image": { # An `Image` chunk is a piece of evidence that comes from an image search result. It contains the URI of the image search result and the URI of the image. This is used to provide the user with a link to the source of the information. # A grounding chunk from an image search result. See the `Image` message for details. + "domain": "A String", # The domain of the image search result page. + "imageUri": "A String", # The URI of the image. + "sourceUri": "A String", # The URI of the image search result page. + "title": "A String", # The title of the image search result page. + }, "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps, containing information about places or routes. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details. "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. "reviewSnippets": [ # Snippets of reviews that were used to generate the answer. @@ -224,6 +230,11 @@

Method Details

], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API. + "route": { # Route information from Google Maps. # Output only. Route information. + "distanceMeters": 42, # The total distance of the route, in meters. + "duration": "A String", # The total duration of the route. + "encodedPolyline": "A String", # An encoded polyline of the route. See https://developers.google.com/maps/documentation/utilities/polylinealgorithm + }, "text": "A String", # The text of the place answer. "title": "A String", # The title of the place. "uri": "A String", # The URI of the place. @@ -249,13 +260,16 @@

Method Details

}, ], "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search. - { # A collection of supporting references for a segment of the model's response. + { # A collection of supporting references for a segment or part of the model's response. "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored. 3.14, ], "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment. 42, ], + "renderedParts": [ # Indices into the `rendered_parts` field of the `GroundingMetadata` message. These indices specify which rendered parts are associated with this support message. + 42, + ], "segment": { # A segment of the content. # The content segment that this support message applies to. "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index. "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content. @@ -264,6 +278,9 @@

Method Details

}, }, ], + "imageSearchQueries": [ # Optional. The image search queries that were used to generate the content. This field is populated only when the grounding source is Google Search with the Image Search search_type enabled. + "A String", + ], "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, @@ -284,10 +301,18 @@

Method Details

"A String", ], }, + "inputTranscription": { # Audio transcription in Server Content. # Optional. Audio transcription of user input. + "finished": True or False, # Optional. The bool indicates the end of the transcription. + "text": "A String", # Optional. Transcription text. + }, "interrupted": True or False, # Optional. Flag indicating that LLM was interrupted when generating the content. Usually it's due to user interruption during a bidi streaming. "longRunningToolIds": [ # Optional. Set of ids of the long running function calls. Agent client will know from this field about which function call is long running. Only valid for function call event. "A String", ], + "outputTranscription": { # Audio transcription in Server Content. # Optional. Audio transcription of model output. + "finished": True or False, # Optional. The bool indicates the end of the transcription. + "text": "A String", # Optional. Transcription text. + }, "partial": True or False, # Optional. Indicates whether the text content is part of a unfinished text stream. Only used for streaming mode and when the content is plain text. "turnComplete": True or False, # Optional. Indicates whether the response from the model is complete. Only used for streaming mode. }, diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html index 99551b7e34..1a6dc87639 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html @@ -221,6 +221,12 @@

Method Details

"googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps. { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information. + "image": { # An `Image` chunk is a piece of evidence that comes from an image search result. It contains the URI of the image search result and the URI of the image. This is used to provide the user with a link to the source of the information. # A grounding chunk from an image search result. See the `Image` message for details. + "domain": "A String", # The domain of the image search result page. + "imageUri": "A String", # The URI of the image. + "sourceUri": "A String", # The URI of the image search result page. + "title": "A String", # The title of the image search result page. + }, "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps, containing information about places or routes. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details. "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. "reviewSnippets": [ # Snippets of reviews that were used to generate the answer. @@ -232,6 +238,11 @@

Method Details

], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API. + "route": { # Route information from Google Maps. # Output only. Route information. + "distanceMeters": 42, # The total distance of the route, in meters. + "duration": "A String", # The total duration of the route. + "encodedPolyline": "A String", # An encoded polyline of the route. See https://developers.google.com/maps/documentation/utilities/polylinealgorithm + }, "text": "A String", # The text of the place answer. "title": "A String", # The title of the place. "uri": "A String", # The URI of the place. @@ -257,13 +268,16 @@

Method Details

}, ], "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search. - { # A collection of supporting references for a segment of the model's response. + { # A collection of supporting references for a segment or part of the model's response. "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored. 3.14, ], "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment. 42, ], + "renderedParts": [ # Indices into the `rendered_parts` field of the `GroundingMetadata` message. These indices specify which rendered parts are associated with this support message. + 42, + ], "segment": { # A segment of the content. # The content segment that this support message applies to. "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index. "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content. @@ -272,6 +286,9 @@

Method Details

}, }, ], + "imageSearchQueries": [ # Optional. The image search queries that were used to generate the content. This field is populated only when the grounding source is Google Search with the Image Search search_type enabled. + "A String", + ], "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, @@ -292,10 +309,18 @@

Method Details

"A String", ], }, + "inputTranscription": { # Audio transcription in Server Content. # Optional. Audio transcription of user input. + "finished": True or False, # Optional. The bool indicates the end of the transcription. + "text": "A String", # Optional. Transcription text. + }, "interrupted": True or False, # Optional. Flag indicating that LLM was interrupted when generating the content. Usually it's due to user interruption during a bidi streaming. "longRunningToolIds": [ # Optional. Set of ids of the long running function calls. Agent client will know from this field about which function call is long running. Only valid for function call event. "A String", ], + "outputTranscription": { # Audio transcription in Server Content. # Optional. Audio transcription of model output. + "finished": True or False, # Optional. The bool indicates the end of the transcription. + "text": "A String", # Optional. Transcription text. + }, "partial": True or False, # Optional. Indicates whether the text content is part of a unfinished text stream. Only used for streaming mode and when the content is plain text. "turnComplete": True or False, # Optional. Indicates whether the response from the model is complete. Only used for streaming mode. }, diff --git a/docs/dyn/aiplatform_v1beta1.v1beta1.html b/docs/dyn/aiplatform_v1beta1.v1beta1.html index aeba48daf3..eb61fee5bf 100644 --- a/docs/dyn/aiplatform_v1beta1.v1beta1.html +++ b/docs/dyn/aiplatform_v1beta1.v1beta1.html @@ -117,6 +117,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -140,7 +141,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -271,6 +272,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -294,7 +296,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -399,6 +401,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -422,7 +425,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -602,6 +605,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -625,7 +629,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -774,8 +778,8 @@

Method Details

}, }, "instance": { # A single instance to be evaluated. Instances are used to specify the input data for evaluation, from simple string comparisons to complex, multi-turn model evaluations # The instance to be evaluated. - "agentData": { # Contains data specific to agent evaluations. # Optional. Deprecated. Use `agent_eval_data` instead. Data used for agent evaluation. - "agentConfig": { # Configuration for an Agent. # Optional. Agent configuration. + "agentData": { # Deprecated: Use `agent_eval_data` instead. Contains data specific to agent evaluations. # Optional. Deprecated: Use `agent_eval_data` instead. Data used for agent evaluation. + "agentConfig": { # Deprecated: Use `google.cloud.aiplatform.master.AgentConfig` in `agent_eval_data` instead. Configuration for an Agent. # Optional. Deprecated: Use `agent_eval_data` instead. Agent configuration. "agentId": "A String", # Optional. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. @@ -895,7 +899,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -935,7 +939,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -976,6 +980,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -1087,7 +1097,7 @@

Method Details

"toolsText": "A String", # A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters. }, "agents": { # Optional. The static Agent Configuration. This map defines the graph structure of the agent system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent (tools, instructions, sub-agents). - "a_key": { # Configuration for an Agent. + "a_key": { # Deprecated: Use `google.cloud.aiplatform.master.AgentConfig` in `agent_eval_data` instead. Configuration for an Agent. "agentId": "A String", # Optional. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. @@ -1207,7 +1217,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1247,7 +1257,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1288,6 +1298,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -1399,7 +1415,7 @@

Method Details

"toolsText": "A String", # A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters. }, }, - "developerInstruction": { # Instance data used to populate placeholders in a metric prompt template. # Optional. Deprecated. A field containing instructions from the developer for the agent. Please use `agents.developer_instruction` or `turns.events.active_instruction` instead. + "developerInstruction": { # Instance data used to populate placeholders in a metric prompt template. # Optional. Deprecated: Use `agents.developer_instruction` or `turns.events.active_instruction` instead. A field containing instructions from the developer for the agent. "contents": { # List of standard Content messages from Gemini API. # List of Gemini content data. "contents": [ # Optional. Repeated contents. { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. @@ -1562,7 +1578,7 @@

Method Details

}, ], }, - "tools": { # Deprecated. Represents a list of tools for an agent. # List of tools. + "tools": { # Deprecated: Use `agent_eval_data` instead. Represents a list of tools for an agent. # List of tools. "tool": [ # Optional. List of tools: each tool can have multiple function declarations. { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. @@ -1592,7 +1608,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1632,7 +1648,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1673,6 +1689,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -1815,7 +1837,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1855,7 +1877,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -1896,6 +1918,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -2091,99 +2119,17 @@

Method Details

}, ], }, - "agentEvalData": { # Contains data specific to agent evaluations. # Optional. Data used for agent evaluation. - "agentConfig": { # Configuration for an Agent. # Optional. Agent configuration. - "agentId": "A String", # Optional. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. - "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. - "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. - "developerInstruction": { # Instance data used to populate placeholders in a metric prompt template. # Optional. Contains instructions from the developer for the agent. Can be static or a dynamic prompt template used with the `AgentEvent.state_delta` field. - "contents": { # List of standard Content messages from Gemini API. # List of Gemini content data. - "contents": [ # Optional. Repeated contents. - { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. - "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. - { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. - "outcome": "A String", # Required. Outcome of the code execution. - "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. - }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. - "code": "A String", # Required. The code to be executed. - "language": "A String", # Required. Programming language of the `code`. - }, - "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. - "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "functionCall": { # 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. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. - "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. - "a_key": "", # Properties of the object. - }, - "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. - "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. - "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. - { # Partial argument value of the function call. - "boolValue": True or False, # Optional. Represents a boolean value. - "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". - "nullValue": "A String", # Optional. Represents a null value. - "numberValue": 3.14, # Optional. Represents a double value. - "stringValue": "A String", # Optional. Represents a string value. - "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. - }, - ], - "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. - }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. - "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. - "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. - "fileData": { # URI based data for function response. # URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - }, - ], - "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. - "a_key": "", # Properties of the object. - }, - "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. - }, - "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. - "data": "A String", # Required. The raw bytes of the data. - "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. - "level": "A String", # The tokenization quality used for given media. - }, - "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. - "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. - "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. - "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. - "startOffset": "A String", # Optional. The start offset of the video. - }, - }, - ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. - }, - ], - }, - "text": "A String", # Text data. - }, - "subAgents": [ # Optional. The list of valid agent IDs (names) that this agent can delegate to. This defines the directed edges in the agent system graph topology. - "A String", - ], - "tools": { # Represents a list of tools for an agent. # List of tools. - "tool": [ # Optional. List of tools: each tool can have multiple function declarations. + "agentEvalData": { # Represents data specific to multi-turn agent evaluations. # Optional. Data used for agent evaluation. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, @@ -2212,7 +2158,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -2246,863 +2192,172 @@

Method Details

"response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. - # Object with schema name: GoogleCloudAiplatformV1beta1Schema - ], - "default": "", # Optional. Default value to use if the field is not specified. - "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. - "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema - }, - "description": "A String", # Optional. Description of the schema. - "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` - "A String", - ], - "example": "", # Optional. Example of an instance of this schema. - "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. - "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. - "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. - "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. - "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. - "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. - "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. - "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. - "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. - "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. - "nullable": True or False, # Optional. Indicates if the value of this field can be null. - "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. - "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. - "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema - }, - "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. - "A String", - ], - "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring - "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. - "A String", - ], - "title": "A String", # Optional. Title for the schema. - "type": "A String", # Optional. Data type of the schema field. - }, - "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. - }, - ], - "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. - "enableWidget": True or False, # Optional. If true, include the widget context token in the response. - }, - "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. - "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. - "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. - "A String", - ], - }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. - "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. - "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. - "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. - }, - }, - "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation - "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. - "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } - "a_key": "", # Properties of the object. - }, - }, - "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. - "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. - "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. - "apiKeyConfig": { # The API secret. # The API secret. - "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} - "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. - }, - }, - "apiSpec": "A String", # The API spec that the external API implements. - "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. - "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. - "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. - "apiKeyString": "A String", # Optional. The API key to be used in the request directly. - "httpElementLocation": "A String", # Optional. The location of the API key. - "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. - }, - "authType": "A String", # Type of auth scheme. - "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. - "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. - }, - "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. - "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. - }, - "oauthConfig": { # Config for user oauth. # Config for user oauth. - "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. - "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. - }, - "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. - "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. - "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). - }, - }, - "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. - "index": "A String", # The ElasticSearch index to use. - "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. - "searchTemplate": "A String", # The ElasticSearch search template to use. - }, - "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search - "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. - }, - }, - "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. - "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. - { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec - "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` - "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) - }, - ], - "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` - "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` - "filter": "A String", # Optional. Filter strings to be passed to the search API. - "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. - }, - "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. - "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. - "A String", - ], - "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. - { # The definition of the Rag resource. - "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` - "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", - ], - }, - ], - "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. - "filter": { # Config for filters. # Optional. Config for filters. - "metadataFilter": "A String", # Optional. String for metadata filtering. - "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. - "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. - }, - "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. - "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. - }, - "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. - "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. - "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). - }, - "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. - "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` - }, - }, - "topK": 42, # Optional. The number of contexts to retrieve. - }, - "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. - "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. - "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. - }, - }, - "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. - }, - }, - ], - }, - "toolsText": "A String", # A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters. - }, - "agents": { # Optional. The static Agent Configuration. This map defines the graph structure of the agent system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent (tools, instructions, sub-agents). - "a_key": { # Configuration for an Agent. - "agentId": "A String", # Optional. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. - "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. - "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. - "developerInstruction": { # Instance data used to populate placeholders in a metric prompt template. # Optional. Contains instructions from the developer for the agent. Can be static or a dynamic prompt template used with the `AgentEvent.state_delta` field. - "contents": { # List of standard Content messages from Gemini API. # List of Gemini content data. - "contents": [ # Optional. Repeated contents. - { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. - "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. - { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. - "outcome": "A String", # Required. Outcome of the code execution. - "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. - }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. - "code": "A String", # Required. The code to be executed. - "language": "A String", # Required. Programming language of the `code`. - }, - "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. - "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "functionCall": { # 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. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. - "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. - "a_key": "", # Properties of the object. - }, - "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. - "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. - "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. - { # Partial argument value of the function call. - "boolValue": True or False, # Optional. Represents a boolean value. - "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". - "nullValue": "A String", # Optional. Represents a null value. - "numberValue": 3.14, # Optional. Represents a double value. - "stringValue": "A String", # Optional. Represents a string value. - "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. - }, - ], - "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. - }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. - "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. - "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. - "fileData": { # URI based data for function response. # URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - }, - ], - "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. - "a_key": "", # Properties of the object. - }, - "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. - }, - "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. - "data": "A String", # Required. The raw bytes of the data. - "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. - "level": "A String", # The tokenization quality used for given media. - }, - "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. - "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. - "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. - "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. - "startOffset": "A String", # Optional. The start offset of the video. - }, - }, - ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. - }, - ], - }, - "text": "A String", # Text data. - }, - "subAgents": [ # Optional. The list of valid agent IDs (names) that this agent can delegate to. This defines the directed edges in the agent system graph topology. - "A String", - ], - "tools": { # Represents a list of tools for an agent. # List of tools. - "tool": [ # Optional. List of tools: each tool can have multiple function declarations. - { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). - "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. - }, - "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. - "environment": "A String", # Required. The environment being operated. - "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. - "A String", - ], - }, - "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. - "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. - "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. - "A String", - ], - }, - "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. - { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. - "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. - "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 - "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. - "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. - # Object with schema name: GoogleCloudAiplatformV1beta1Schema - ], - "default": "", # Optional. Default value to use if the field is not specified. - "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. - "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema - }, - "description": "A String", # Optional. Description of the schema. - "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` - "A String", - ], - "example": "", # Optional. Example of an instance of this schema. - "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. - "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. - "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. - "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. - "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. - "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. - "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. - "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. - "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. - "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. - "nullable": True or False, # Optional. Indicates if the value of this field can be null. - "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. - "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. - "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema - }, - "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. - "A String", - ], - "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring - "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. - "A String", - ], - "title": "A String", # Optional. Title for the schema. - "type": "A String", # Optional. Data type of the schema field. - }, - "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. - "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. - "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. - "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. - # Object with schema name: GoogleCloudAiplatformV1beta1Schema - ], - "default": "", # Optional. Default value to use if the field is not specified. - "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. - "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema - }, - "description": "A String", # Optional. Description of the schema. - "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` - "A String", - ], - "example": "", # Optional. Example of an instance of this schema. - "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. - "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. - "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. - "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. - "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. - "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. - "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. - "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. - "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. - "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. - "nullable": True or False, # Optional. Indicates if the value of this field can be null. - "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. - "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. - "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema - }, - "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. - "A String", - ], - "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring - "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. - "A String", - ], - "title": "A String", # Optional. Title for the schema. - "type": "A String", # Optional. Data type of the schema field. - }, - "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. - }, - ], - "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. - "enableWidget": True or False, # Optional. If true, include the widget context token in the response. - }, - "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. - "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. - "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. - "A String", - ], - }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. - "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. - "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. - "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. - }, - }, - "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation - "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. - "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } - "a_key": "", # Properties of the object. - }, - }, - "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. - "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. - "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. - "apiKeyConfig": { # The API secret. # The API secret. - "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} - "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. - }, - }, - "apiSpec": "A String", # The API spec that the external API implements. - "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. - "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. - "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. - "apiKeyString": "A String", # Optional. The API key to be used in the request directly. - "httpElementLocation": "A String", # Optional. The location of the API key. - "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. - }, - "authType": "A String", # Type of auth scheme. - "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. - "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. - }, - "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. - "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. - }, - "oauthConfig": { # Config for user oauth. # Config for user oauth. - "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. - "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. - }, - "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. - "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. - "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). - }, - }, - "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. - "index": "A String", # The ElasticSearch index to use. - "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. - "searchTemplate": "A String", # The ElasticSearch search template to use. - }, - "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search - "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. - }, - }, - "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. - "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. - { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec - "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` - "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) - }, - ], - "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` - "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` - "filter": "A String", # Optional. Filter strings to be passed to the search API. - "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. - }, - "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. - "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. - "A String", - ], - "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. - { # The definition of the Rag resource. - "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` - "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", - ], - }, - ], - "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. - "filter": { # Config for filters. # Optional. Config for filters. - "metadataFilter": "A String", # Optional. String for metadata filtering. - "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. - "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. - }, - "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. - "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. - }, - "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. - "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. - "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). - }, - "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. - "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` - }, - }, - "topK": 42, # Optional. The number of contexts to retrieve. - }, - "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. - "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. - "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. - }, - }, - "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. - }, - }, - ], - }, - "toolsText": "A String", # A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters. - }, - }, - "developerInstruction": { # Instance data used to populate placeholders in a metric prompt template. # Optional. Deprecated. A field containing instructions from the developer for the agent. Please use `agents.developer_instruction` or `turns.events.active_instruction` instead. - "contents": { # List of standard Content messages from Gemini API. # List of Gemini content data. - "contents": [ # Optional. Repeated contents. - { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. - "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. - { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. - "outcome": "A String", # Required. Outcome of the code execution. - "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. - }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. - "code": "A String", # Required. The code to be executed. - "language": "A String", # Required. Programming language of the `code`. - }, - "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. - "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "functionCall": { # 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. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. - "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. - "a_key": "", # Properties of the object. - }, - "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. - "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. - "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. - { # Partial argument value of the function call. - "boolValue": True or False, # Optional. Represents a boolean value. - "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". - "nullValue": "A String", # Optional. Represents a null value. - "numberValue": 3.14, # Optional. Represents a double value. - "stringValue": "A String", # Optional. Represents a string value. - "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. - }, - ], - "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. - }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. - "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. - "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. - "fileData": { # URI based data for function response. # URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - }, - ], - "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. - "a_key": "", # Properties of the object. - }, - "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. - }, - "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. - "data": "A String", # Required. The raw bytes of the data. - "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. - "level": "A String", # The tokenization quality used for given media. - }, - "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. - "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. - "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. - "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. - "startOffset": "A String", # Optional. The start offset of the video. - }, - }, - ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. - }, - ], - }, - "text": "A String", # Text data. - }, - "events": { # Represents a list of events for an agent. # A list of events. - "event": [ # Optional. A list of events. - { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. - "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. - { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. - "outcome": "A String", # Required. Outcome of the code execution. - "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. - }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. - "code": "A String", # Required. The code to be executed. - "language": "A String", # Required. Programming language of the `code`. - }, - "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. - "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "functionCall": { # 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. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. - "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. - "a_key": "", # Properties of the object. - }, - "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. - "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. - "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. - { # Partial argument value of the function call. - "boolValue": True or False, # Optional. Represents a boolean value. - "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". - "nullValue": "A String", # Optional. Represents a null value. - "numberValue": 3.14, # Optional. Represents a double value. - "stringValue": "A String", # Optional. Represents a string value. - "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. - }, - ], - "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. - }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. - "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. - "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. - "fileData": { # URI based data for function response. # URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - }, - ], - "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. - "a_key": "", # Properties of the object. - }, - "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. - }, - "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. - "data": "A String", # Required. The raw bytes of the data. - "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. - "level": "A String", # The tokenization quality used for given media. - }, - "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. - "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. - "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. - "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. - "startOffset": "A String", # Optional. The start offset of the video. - }, - }, - ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. - }, - ], - }, - "tools": { # Deprecated. Represents a list of tools for an agent. # List of tools. - "tool": [ # Optional. List of tools: each tool can have multiple function declarations. - { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). - "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. - }, - "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. - "environment": "A String", # Required. The environment being operated. - "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. - "A String", - ], - }, - "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. - "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. - "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. - "A String", - ], - }, - "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. - { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. - "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. - "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 - "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. - "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. - # Object with schema name: GoogleCloudAiplatformV1beta1Schema - ], - "default": "", # Optional. Default value to use if the field is not specified. - "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. - "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema - }, - "description": "A String", # Optional. Description of the schema. - "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` - "A String", - ], - "example": "", # Optional. Example of an instance of this schema. - "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. - "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. - "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. - "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. - "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. - "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. - "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. - "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. - "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. - "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. - "nullable": True or False, # Optional. Indicates if the value of this field can be null. - "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. - "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. - "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema - }, - "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. - "A String", - ], - "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring - "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. - "A String", - ], - "title": "A String", # Optional. Title for the schema. - "type": "A String", # Optional. Data type of the schema field. - }, - "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. - "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. - "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. - "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. - # Object with schema name: GoogleCloudAiplatformV1beta1Schema - ], - "default": "", # Optional. Default value to use if the field is not specified. - "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. - "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema - }, - "description": "A String", # Optional. Description of the schema. - "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` - "A String", - ], - "example": "", # Optional. Example of an instance of this schema. - "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. - "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. - "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. - "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. - "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. - "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. - "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. - "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. - "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. - "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. - "nullable": True or False, # Optional. Indicates if the value of this field can be null. - "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. - "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. - "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. }, - "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. - "A String", - ], - "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring - "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. - "A String", - ], - "title": "A String", # Optional. Title for the schema. - "type": "A String", # Optional. Data type of the schema field. + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. }, - "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. - }, - ], - "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. - "enableWidget": True or False, # Optional. If true, include the widget context token in the response. - }, - "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. - "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. - "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. - "A String", ], - }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. - "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. - "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. - "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. - }, - }, - "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation - "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. - "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } - "a_key": "", # Properties of the object. + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, - }, - "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. - "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. - "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. - "apiKeyConfig": { # The API secret. # The API secret. - "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} - "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. - }, - }, - "apiSpec": "A String", # The API spec that the external API implements. - "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. - "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. - "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. - "apiKeyString": "A String", # Optional. The API key to be used in the request directly. - "httpElementLocation": "A String", # Optional. The location of the API key. - "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. - }, - "authType": "A String", # Type of auth scheme. - "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. - "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. - }, - "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. - "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. - }, - "oauthConfig": { # Config for user oauth. # Config for user oauth. - "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. - "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. }, - "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. - "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. - "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. }, }, - "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. - "index": "A String", # The ElasticSearch index to use. - "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. - "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. }, - "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search - "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. + "customConfigs": { # Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } + "a_key": "", # Properties of the object. }, }, - "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. - "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. - { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec - "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` - "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, }, - ], - "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` - "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` - "filter": "A String", # Optional. Filter strings to be passed to the search API. - "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. - }, - "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. - "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. - "A String", - ], - "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. - { # The definition of the Rag resource. - "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` - "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", - ], + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, }, - ], - "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. - "filter": { # Config for filters. # Optional. Config for filters. - "metadataFilter": "A String", # Optional. String for metadata filtering. - "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. - "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. }, - "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. - "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. }, - "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. - "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. - "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) }, - "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. - "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. + "A String", + ], + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, }, + "topK": 42, # Optional. The number of contexts to retrieve. }, - "topK": 42, # Optional. The number of contexts to retrieve. + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, - "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. - "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. - "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. }, }, - "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. - }, - }, - ], + ], + }, }, - "toolsText": "A String", # A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters. - "turns": [ # Optional. The chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). + "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). { # Represents a single turn/invocation in the conversation. "events": [ # Optional. The list of events that occurred during this turn. - { # A single event in the execution trace. + { # Represents a single event in the execution trace. "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. @@ -3132,7 +2387,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -3172,7 +2427,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -3213,6 +2468,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -3320,7 +2581,7 @@

Method Details

}, }, ], - "author": "A String", # Required. The ID of the agent or entity that generated this event. + "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. @@ -3803,6 +3064,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -3826,7 +3088,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -3931,6 +3193,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -3954,7 +3217,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -4847,7 +4110,7 @@

Method Details

The object takes the form of: { # Request message for EvaluationService.GenerateInstanceRubrics. - "agentConfig": { # Configuration for an Agent. # Optional. Agent configuration, required for agent-based rubric generation. + "agentConfig": { # Deprecated: Use `google.cloud.aiplatform.master.AgentConfig` in `agent_eval_data` instead. Configuration for an Agent. # Optional. Agent configuration, required for agent-based rubric generation. "agentId": "A String", # Optional. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. @@ -4967,7 +4230,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -5007,7 +4270,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], @@ -5048,6 +4311,12 @@

Method Details

"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. @@ -5260,6 +4529,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -5283,7 +4553,7 @@

Method Details

"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. Description of the schema. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` "A String", ], diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1.json index e1c898a048..5789c86765 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1.json @@ -6315,6 +6315,62 @@ "resources": { "locations": { "methods": { +"askContexts": { +"description": "Agentic Retrieval Ask API for RAG.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:askContexts", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.askContexts", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}:askContexts", +"request": { +"$ref": "GoogleCloudAiplatformV1AskContextsRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1AskContextsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"asyncRetrieveContexts": { +"description": "Asynchronous API to retrieves relevant contexts for a query.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:asyncRetrieveContexts", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.asyncRetrieveContexts", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}:asyncRetrieveContexts", +"request": { +"$ref": "GoogleCloudAiplatformV1AsyncRetrieveContextsRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "augmentPrompt": { "description": "Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:augmentPrompt", @@ -10488,6 +10544,40 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] +}, +"responses": { +"description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/openapi/responses", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.endpoints.openapi.responses", +"parameterOrder": [ +"endpoint" +], +"parameters": { +"deployedModelId": { +"description": "ID of the DeployedModel that serves the invoke request.", +"location": "query", +"type": "string" +}, +"endpoint": { +"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/openapi$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+endpoint}/responses", +"request": { +"$ref": "GoogleApiHttpBody" +}, +"response": { +"$ref": "GoogleApiHttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] } } }, @@ -30765,9 +30855,42 @@ } } }, -"revision": "20260217", +"revision": "20260302", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { +"CloudAiLargeModelsVisionGenerateVideoExperiments": { +"description": "Experimental parameters for video generation.", +"id": "CloudAiLargeModelsVisionGenerateVideoExperiments", +"properties": { +"humanPose": { +"$ref": "CloudAiLargeModelsVisionHumanPose", +"description": "Human pose parameters for Pose Control" +}, +"modelName": { +"description": "Model names, as defined in: xyz ", +"type": "string" +}, +"numDiffusionSteps": { +"description": "Number of diffusion steps", +"format": "int32", +"type": "integer" +}, +"promptInputs": { +"$ref": "CloudAiLargeModelsVisionPromptInputs", +"description": "Prompt chunks for \"ProModel\" prompting. If set, the prompt will not be rewritten, and top-level prompt ignored." +}, +"videoTransformMaskGcsUri": { +"description": "GCS URI of the grayscale video mask for Differential Diffusion. Maps to sdedit_video_tmax_scale_map ", +"type": "string" +}, +"videoTransformStrength": { +"description": "SDEdit: Scalar noise level (0.0 to 1.0) Maps to sdedit_tmax ", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, "CloudAiLargeModelsVisionGenerateVideoResponse": { "description": "Generate video response.", "id": "CloudAiLargeModelsVisionGenerateVideoResponse", @@ -30808,6 +30931,10 @@ "description": "Base64 encoded bytes string representing the video.", "type": "string" }, +"experimentsMetadata": { +"$ref": "CloudAiLargeModelsVisionGenerateVideoExperiments", +"description": "Optional metadata returned from experimental requests. Likely only includes the rewritten prompt chunks." +}, "gcsUri": { "description": "Cloud Storage URI where the generated video is written.", "type": "string" @@ -30819,6 +30946,20 @@ }, "type": "object" }, +"CloudAiLargeModelsVisionHumanPose": { +"id": "CloudAiLargeModelsVisionHumanPose", +"properties": { +"bodyLandmarksGcsUri": { +"description": "GCS URI of the human pose video to condition video generation.", +"type": "string" +}, +"faceLandmarksGcsUri": { +"description": "GCS URI of the face landmarks video to condition video generation.", +"type": "string" +} +}, +"type": "object" +}, "CloudAiLargeModelsVisionImage": { "description": "Image.", "id": "CloudAiLargeModelsVisionImage", @@ -30951,6 +31092,36 @@ }, "type": "object" }, +"CloudAiLargeModelsVisionPromptInputs": { +"description": "\"Direct\" prompting for Experimental Video Generation. These will be sent directly to the LDM without being rewritten.", +"id": "CloudAiLargeModelsVisionPromptInputs", +"properties": { +"audioPrompt": { +"description": "Description of audio content in the video, without speech.", +"type": "string" +}, +"negativeAudioPrompt": { +"description": "Negative description of audio content in the video.", +"type": "string" +}, +"negativePrompt": { +"description": "Single negative prompt for what not to generate.", +"type": "string" +}, +"promptChunks": { +"description": "2s, 256 tokens per chunk, 4 total chunks. Required.", +"items": { +"type": "string" +}, +"type": "array" +}, +"transcript": { +"description": "Spoken transcript of the video for characters.", +"type": "string" +} +}, +"type": "object" +}, "CloudAiLargeModelsVisionRaiInfo": { "description": "Next ID: 6", "id": "CloudAiLargeModelsVisionRaiInfo", @@ -31577,6 +31748,39 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1AskContextsRequest": { +"description": "Agentic Retrieval Ask API for RAG. Request message for VertexRagService.AskContexts.", +"id": "GoogleCloudAiplatformV1AskContextsRequest", +"properties": { +"query": { +"$ref": "GoogleCloudAiplatformV1RagQuery", +"description": "Required. Single RAG retrieve query." +}, +"tools": { +"description": "Optional. The tools to use for AskContexts.", +"items": { +"$ref": "GoogleCloudAiplatformV1Tool" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1AskContextsResponse": { +"description": "Response message for VertexRagService.AskContexts.", +"id": "GoogleCloudAiplatformV1AskContextsResponse", +"properties": { +"contexts": { +"$ref": "GoogleCloudAiplatformV1RagContexts", +"description": "The contexts of the query." +}, +"response": { +"description": "The Retrieval Response.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1AssignNotebookRuntimeOperationMetadata": { "description": "Metadata information for NotebookService.AssignNotebookRuntime.", "id": "GoogleCloudAiplatformV1AssignNotebookRuntimeOperationMetadata", @@ -31611,6 +31815,24 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1AsyncRetrieveContextsRequest": { +"description": "Request message for VertexRagService.AsyncRetrieveContexts.", +"id": "GoogleCloudAiplatformV1AsyncRetrieveContextsRequest", +"properties": { +"query": { +"$ref": "GoogleCloudAiplatformV1RagQuery", +"description": "Required. Single RAG retrieve query." +}, +"tools": { +"description": "Optional. The tools to use for AskContexts.", +"items": { +"$ref": "GoogleCloudAiplatformV1Tool" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1Attribution": { "description": "Attribution that explains a particular prediction output.", "id": "GoogleCloudAiplatformV1Attribution", @@ -35903,20 +36125,23 @@ "id": "GoogleCloudAiplatformV1EmbedContentRequest", "properties": { "autoTruncate": { -"description": "Optional. Whether to silently truncate the input content if it's longer than the maximum sequence length.", +"deprecated": true, +"description": "Optional. Deprecated: Please use EmbedContentConfig.auto_truncate instead. Whether to silently truncate the input content if it's longer than the maximum sequence length.", "type": "boolean" }, "content": { "$ref": "GoogleCloudAiplatformV1Content", -"description": "Required. Input content to be embedded. Required." +"description": "Required. The content to be embedded." }, "outputDimensionality": { -"description": "Optional. Optional reduced dimension for the output embedding. If set, excessive values in the output embedding are truncated from the end.", +"deprecated": true, +"description": "Optional. Deprecated: Please use EmbedContentConfig.output_dimensionality instead. Reduced dimension for the output embedding. If set, excessive values in the output embedding are truncated from the end.", "format": "int32", "type": "integer" }, "taskType": { -"description": "Optional. The task type of the embedding.", +"deprecated": true, +"description": "Optional. Deprecated: Please use EmbedContentConfig.task_type instead. The task type of the embedding.", "enum": [ "UNSPECIFIED", "RETRIEVAL_QUERY", @@ -35942,7 +36167,8 @@ "type": "string" }, "title": { -"description": "Optional. An optional title for the text.", +"deprecated": true, +"description": "Optional. Deprecated: Please use EmbedContentConfig.title instead. The title for the text.", "type": "string" } }, @@ -35962,7 +36188,7 @@ }, "usageMetadata": { "$ref": "GoogleCloudAiplatformV1UsageMetadata", -"description": "Metadata about the response(s)." +"description": "Usage metadata about the response(s)." } }, "type": "object" @@ -36334,6 +36560,39 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1EvaluateDatasetRun": { +"description": "Evaluate Dataset Run Result for Tuning Job.", +"id": "GoogleCloudAiplatformV1EvaluateDatasetRun", +"properties": { +"checkpointId": { +"description": "Output only. The checkpoint id used in the evaluation run. Only populated when evaluating checkpoints.", +"readOnly": true, +"type": "string" +}, +"error": { +"$ref": "GoogleRpcStatus", +"description": "Output only. The error of the evaluation run if any.", +"readOnly": true +}, +"evaluateDatasetResponse": { +"$ref": "GoogleCloudAiplatformV1EvaluateDatasetResponse", +"description": "Output only. Results for EvaluationService.", +"readOnly": true +}, +"evaluationRun": { +"description": "Output only. The resource name of the evaluation run. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run_id}`.", +"readOnly": true, +"type": "string" +}, +"operationName": { +"deprecated": true, +"description": "Output only. Deprecated: The updated architecture uses evaluation_run instead.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1EvaluateInstancesRequest": { "description": "Request message for EvaluationService.EvaluateInstances.", "id": "GoogleCloudAiplatformV1EvaluateInstancesRequest", @@ -36709,6 +36968,32 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1EvaluationConfig": { +"description": "Evaluation Config for Tuning Job.", +"id": "GoogleCloudAiplatformV1EvaluationConfig", +"properties": { +"autoraterConfig": { +"$ref": "GoogleCloudAiplatformV1AutoraterConfig", +"description": "Optional. Autorater config for evaluation." +}, +"inferenceGenerationConfig": { +"$ref": "GoogleCloudAiplatformV1GenerationConfig", +"description": "Optional. Configuration options for inference generation and outputs. If not set, default generation parameters are used." +}, +"metrics": { +"description": "Required. The metrics used for evaluation.", +"items": { +"$ref": "GoogleCloudAiplatformV1Metric" +}, +"type": "array" +}, +"outputConfig": { +"$ref": "GoogleCloudAiplatformV1OutputConfig", +"description": "Required. Config for evaluation output." +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1EvaluationDataset": { "description": "The dataset used for evaluation.", "id": "GoogleCloudAiplatformV1EvaluationDataset", @@ -36729,13 +37014,9 @@ "id": "GoogleCloudAiplatformV1EvaluationInstance", "properties": { "agentData": { -"$ref": "GoogleCloudAiplatformV1EvaluationInstanceAgentData", +"$ref": "GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentData", "deprecated": true, -"description": "Optional. Deprecated. Use `agent_eval_data` instead. Data used for agent evaluation." -}, -"agentEvalData": { -"$ref": "GoogleCloudAiplatformV1EvaluationInstanceAgentData", -"description": "Optional. Data used for agent evaluation." +"description": "Optional. Deprecated: Use `agent_eval_data` instead. Data used for agent evaluation." }, "otherData": { "$ref": "GoogleCloudAiplatformV1EvaluationInstanceMapInstance", @@ -36763,10 +37044,10 @@ }, "type": "object" }, -"GoogleCloudAiplatformV1EvaluationInstanceAgentConfig": { +"GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentConfig": { "deprecated": true, -"description": "Configuration for an Agent.", -"id": "GoogleCloudAiplatformV1EvaluationInstanceAgentConfig", +"description": "Deprecated: Use `google.cloud.aiplatform.master.AgentConfig` in `agent_eval_data` instead. Configuration for an Agent.", +"id": "GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentConfig", "properties": { "agentId": { "description": "Optional. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map.", @@ -36792,7 +37073,7 @@ "type": "array" }, "tools": { -"$ref": "GoogleCloudAiplatformV1EvaluationInstanceAgentConfigTools", +"$ref": "GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentConfigTools", "description": "List of tools." }, "toolsText": { @@ -36802,9 +37083,9 @@ }, "type": "object" }, -"GoogleCloudAiplatformV1EvaluationInstanceAgentConfigTools": { +"GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentConfigTools": { "description": "Represents a list of tools for an agent.", -"id": "GoogleCloudAiplatformV1EvaluationInstanceAgentConfigTools", +"id": "GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentConfigTools", "properties": { "tool": { "description": "Optional. List of tools: each tool can have multiple function declarations.", @@ -36816,18 +37097,18 @@ }, "type": "object" }, -"GoogleCloudAiplatformV1EvaluationInstanceAgentData": { +"GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentData": { "deprecated": true, -"description": "Contains data specific to agent evaluations.", -"id": "GoogleCloudAiplatformV1EvaluationInstanceAgentData", +"description": "Deprecated: Use `agent_eval_data` instead. Contains data specific to agent evaluations.", +"id": "GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentData", "properties": { "agentConfig": { -"$ref": "GoogleCloudAiplatformV1EvaluationInstanceAgentConfig", -"description": "Optional. Agent configuration." +"$ref": "GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentConfig", +"description": "Optional. Deprecated: Use `agent_eval_data` instead. Agent configuration." }, "agents": { "additionalProperties": { -"$ref": "GoogleCloudAiplatformV1EvaluationInstanceAgentConfig" +"$ref": "GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentConfig" }, "description": "Optional. The static Agent Configuration. This map defines the graph structure of the agent system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent (tools, instructions, sub-agents).", "type": "object" @@ -36835,14 +37116,14 @@ "developerInstruction": { "$ref": "GoogleCloudAiplatformV1EvaluationInstanceInstanceData", "deprecated": true, -"description": "Optional. Deprecated. A field containing instructions from the developer for the agent. Please use `agents.developer_instruction` or `turns.events.active_instruction` instead." +"description": "Optional. Deprecated: Use `agents.developer_instruction` or `turns.events.active_instruction` instead. A field containing instructions from the developer for the agent." }, "events": { -"$ref": "GoogleCloudAiplatformV1EvaluationInstanceAgentDataEvents", +"$ref": "GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentDataEvents", "description": "A list of events." }, "tools": { -"$ref": "GoogleCloudAiplatformV1EvaluationInstanceAgentDataTools", +"$ref": "GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentDataTools", "deprecated": true, "description": "List of tools." }, @@ -36854,16 +37135,16 @@ "turns": { "description": "Optional. The chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response).", "items": { -"$ref": "GoogleCloudAiplatformV1EvaluationInstanceAgentDataConversationTurn" +"$ref": "GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentDataConversationTurn" }, "type": "array" } }, "type": "object" }, -"GoogleCloudAiplatformV1EvaluationInstanceAgentDataAgentEvent": { +"GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentDataAgentEvent": { "description": "A single event in the execution trace.", -"id": "GoogleCloudAiplatformV1EvaluationInstanceAgentDataAgentEvent", +"id": "GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentDataAgentEvent", "properties": { "activeTools": { "description": "Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set.", @@ -36896,14 +37177,14 @@ }, "type": "object" }, -"GoogleCloudAiplatformV1EvaluationInstanceAgentDataConversationTurn": { +"GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentDataConversationTurn": { "description": "Represents a single turn/invocation in the conversation.", -"id": "GoogleCloudAiplatformV1EvaluationInstanceAgentDataConversationTurn", +"id": "GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentDataConversationTurn", "properties": { "events": { "description": "Optional. The list of events that occurred during this turn.", "items": { -"$ref": "GoogleCloudAiplatformV1EvaluationInstanceAgentDataAgentEvent" +"$ref": "GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentDataAgentEvent" }, "type": "array" }, @@ -36919,9 +37200,9 @@ }, "type": "object" }, -"GoogleCloudAiplatformV1EvaluationInstanceAgentDataEvents": { +"GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentDataEvents": { "description": "Represents a list of events for an agent.", -"id": "GoogleCloudAiplatformV1EvaluationInstanceAgentDataEvents", +"id": "GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentDataEvents", "properties": { "event": { "description": "Optional. A list of events.", @@ -36933,9 +37214,9 @@ }, "type": "object" }, -"GoogleCloudAiplatformV1EvaluationInstanceAgentDataTools": { -"description": "Deprecated. Represents a list of tools for an agent.", -"id": "GoogleCloudAiplatformV1EvaluationInstanceAgentDataTools", +"GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentDataTools": { +"description": "Deprecated: Use `agent_eval_data` instead. Represents a list of tools for an agent.", +"id": "GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentDataTools", "properties": { "tool": { "deprecated": true, @@ -37734,6 +38015,10 @@ "$ref": "GoogleCloudAiplatformV1GroundingMetadata", "description": "Optional. Metadata returned to client when grounding is enabled." }, +"inputTranscription": { +"$ref": "GoogleCloudAiplatformV1Transcription", +"description": "Optional. Audio transcription of user input." +}, "interrupted": { "description": "Optional. Flag indicating that LLM was interrupted when generating the content. Usually it's due to user interruption during a bidi streaming.", "type": "boolean" @@ -37745,6 +38030,10 @@ }, "type": "array" }, +"outputTranscription": { +"$ref": "GoogleCloudAiplatformV1Transcription", +"description": "Optional. Audio transcription of model output." +}, "partial": { "description": "Optional. Indicates whether the text content is part of a unfinished text stream. Only used for streaming mode and when the content is plain text.", "type": "boolean" @@ -41130,7 +41419,7 @@ "id": "GoogleCloudAiplatformV1GenerateInstanceRubricsRequest", "properties": { "agentConfig": { -"$ref": "GoogleCloudAiplatformV1EvaluationInstanceAgentConfig", +"$ref": "GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentConfig", "description": "Optional. Agent configuration, required for agent-based rubric generation." }, "contents": { @@ -41805,6 +42094,10 @@ "description": "A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information.", "id": "GoogleCloudAiplatformV1GroundingChunk", "properties": { +"image": { +"$ref": "GoogleCloudAiplatformV1GroundingChunkImage", +"description": "A grounding chunk from an image search result. See the `Image` message for details." +}, "maps": { "$ref": "GoogleCloudAiplatformV1GroundingChunkMaps", "description": "A grounding chunk from Google Maps. See the `Maps` message for details." @@ -41820,6 +42113,29 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1GroundingChunkImage": { +"description": "An `Image` chunk is a piece of evidence that comes from an image search result. It contains the URI of the image search result and the URI of the image. This is used to provide the user with a link to the source of the information.", +"id": "GoogleCloudAiplatformV1GroundingChunkImage", +"properties": { +"domain": { +"description": "The domain of the image search result page.", +"type": "string" +}, +"imageUri": { +"description": "The URI of the image.", +"type": "string" +}, +"sourceUri": { +"description": "The URI of the image search result page.", +"type": "string" +}, +"title": { +"description": "The title of the image search result page.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1GroundingChunkMaps": { "description": "A `Maps` chunk is a piece of evidence that comes from Google Maps, containing information about places or routes. This is used to provide the user with rich, location-based information.", "id": "GoogleCloudAiplatformV1GroundingChunkMaps", @@ -41832,6 +42148,11 @@ "description": "This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API.", "type": "string" }, +"route": { +"$ref": "GoogleCloudAiplatformV1GroundingChunkMapsRoute", +"description": "Output only. Route information.", +"readOnly": true +}, "text": { "description": "The text of the place answer.", "type": "string" @@ -41880,6 +42201,27 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1GroundingChunkMapsRoute": { +"description": "Route information from Google Maps.", +"id": "GoogleCloudAiplatformV1GroundingChunkMapsRoute", +"properties": { +"distanceMeters": { +"description": "The total distance of the route, in meters.", +"format": "int32", +"type": "integer" +}, +"duration": { +"description": "The total duration of the route.", +"format": "google-duration", +"type": "string" +}, +"encodedPolyline": { +"description": "An encoded polyline of the route. See https://developers.google.com/maps/documentation/utilities/polylinealgorithm", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1GroundingChunkRetrievedContext": { "description": "Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset.", "id": "GoogleCloudAiplatformV1GroundingChunkRetrievedContext", @@ -41950,6 +42292,13 @@ }, "type": "array" }, +"imageSearchQueries": { +"description": "Optional. The image search queries that were used to generate the content. This field is populated only when the grounding source is Google Search with the Image Search search_type enabled.", +"items": { +"type": "string" +}, +"type": "array" +}, "retrievalMetadata": { "$ref": "GoogleCloudAiplatformV1RetrievalMetadata", "description": "Optional. Output only. Metadata related to the retrieval grounding source.", @@ -41993,7 +42342,7 @@ "type": "object" }, "GoogleCloudAiplatformV1GroundingSupport": { -"description": "A collection of supporting references for a segment of the model's response.", +"description": "A collection of supporting references for a segment or part of the model's response.", "id": "GoogleCloudAiplatformV1GroundingSupport", "properties": { "confidenceScores": { @@ -42012,6 +42361,14 @@ }, "type": "array" }, +"renderedParts": { +"description": "Indices into the `rendered_parts` field of the `GroundingMetadata` message. These indices specify which rendered parts are associated with this support message.", +"items": { +"format": "int32", +"type": "integer" +}, +"type": "array" +}, "segment": { "$ref": "GoogleCloudAiplatformV1Segment", "description": "The content segment that this support message applies to." @@ -42194,6 +42551,20 @@ "Prevents the model from generating images of people." ], "type": "string" +}, +"prominentPeople": { +"description": "Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people.", +"enum": [ +"PROMINENT_PEOPLE_UNSPECIFIED", +"ALLOW_PROMINENT_PEOPLE", +"BLOCK_PROMINENT_PEOPLE" +], +"enumDescriptions": [ +"Unspecified value. The model will proceed with the default behavior, which is to allow generation of prominent people.", +"Allows the model to generate images of prominent people.", +"Prevents the model from generating images of prominent people." +], +"type": "string" } }, "type": "object" @@ -53573,7 +53944,7 @@ false "type": "object" }, "description": { -"description": "Optional. Description of the schema.", +"description": "Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.", "type": "string" }, "enum": { @@ -59716,6 +60087,10 @@ false "description": "Tuning Spec for Supervised Tuning for first party models.", "id": "GoogleCloudAiplatformV1SupervisedTuningSpec", "properties": { +"evaluationConfig": { +"$ref": "GoogleCloudAiplatformV1EvaluationConfig", +"description": "Optional. Evaluation Config for Tuning Job." +}, "exportLastCheckpointOnly": { "description": "Optional. If set to true, disable intermediate checkpoints for SFT and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for SFT. Default is false.", "type": "boolean" @@ -60582,10 +60957,41 @@ false "type": "string" }, "type": "array" +}, +"searchTypes": { +"$ref": "GoogleCloudAiplatformV1ToolGoogleSearchSearchTypes", +"description": "Optional. The set of search types to enable. If not set, web search is enabled by default." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1ToolGoogleSearchImageSearch": { +"description": "Image search for grounding and related configurations.", +"id": "GoogleCloudAiplatformV1ToolGoogleSearchImageSearch", +"properties": {}, +"type": "object" +}, +"GoogleCloudAiplatformV1ToolGoogleSearchSearchTypes": { +"description": "Different types of search that can be enabled on the GoogleSearch tool.", +"id": "GoogleCloudAiplatformV1ToolGoogleSearchSearchTypes", +"properties": { +"imageSearch": { +"$ref": "GoogleCloudAiplatformV1ToolGoogleSearchImageSearch", +"description": "Optional. Setting this field enables image search. Image bytes are returned." +}, +"webSearch": { +"$ref": "GoogleCloudAiplatformV1ToolGoogleSearchWebSearch", +"description": "Optional. Setting this field enables web search. Only text results are returned." } }, "type": "object" }, +"GoogleCloudAiplatformV1ToolGoogleSearchWebSearch": { +"description": "Standard web search for grounding and related configurations. Only text results are returned.", +"id": "GoogleCloudAiplatformV1ToolGoogleSearchWebSearch", +"properties": {}, +"type": "object" +}, "GoogleCloudAiplatformV1ToolNameMatchInput": { "description": "Input for tool name match metric.", "id": "GoogleCloudAiplatformV1ToolNameMatchInput", @@ -61352,6 +61758,21 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1Transcription": { +"description": "Audio transcription in Server Content.", +"id": "GoogleCloudAiplatformV1Transcription", +"properties": { +"finished": { +"description": "Optional. The bool indicates the end of the transcription.", +"type": "boolean" +}, +"text": { +"description": "Optional. Transcription text.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1Trial": { "description": "A message representing a Trial. A Trial contains a unique set of Parameters that has been or will be evaluated, along with the objective metrics got by running the Trial.", "id": "GoogleCloudAiplatformV1Trial", @@ -61598,6 +62019,14 @@ false "description": "Output only. Only populated when job's state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.", "readOnly": true }, +"evaluateDatasetRuns": { +"description": "Output only. Evaluation runs for the Tuning Job.", +"items": { +"$ref": "GoogleCloudAiplatformV1EvaluateDatasetRun" +}, +"readOnly": true, +"type": "array" +}, "experiment": { "description": "Output only. The Experiment associated with this TuningJob.", "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json index 9712e2dc1b..63681ae63c 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json @@ -8268,6 +8268,62 @@ "resources": { "locations": { "methods": { +"askContexts": { +"description": "Agentic Retrieval Ask API for RAG.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:askContexts", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.askContexts", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}:askContexts", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1AskContextsRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1AskContextsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"asyncRetrieveContexts": { +"description": "Asynchronous API to retrieves relevant contexts for a query.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:asyncRetrieveContexts", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.asyncRetrieveContexts", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}:asyncRetrieveContexts", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1AsyncRetrieveContextsRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "augmentPrompt": { "description": "Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:augmentPrompt", @@ -13120,6 +13176,40 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] +}, +"responses": { +"description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/openapi/responses", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.endpoints.openapi.responses", +"parameterOrder": [ +"endpoint" +], +"parameters": { +"deployedModelId": { +"description": "ID of the DeployedModel that serves the invoke request.", +"location": "query", +"type": "string" +}, +"endpoint": { +"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/openapi$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+endpoint}/responses", +"request": { +"$ref": "GoogleApiHttpBody" +}, +"response": { +"$ref": "GoogleApiHttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] } } }, @@ -38816,9 +38906,42 @@ } } }, -"revision": "20260217", +"revision": "20260302", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { +"CloudAiLargeModelsVisionGenerateVideoExperiments": { +"description": "Experimental parameters for video generation.", +"id": "CloudAiLargeModelsVisionGenerateVideoExperiments", +"properties": { +"humanPose": { +"$ref": "CloudAiLargeModelsVisionHumanPose", +"description": "Human pose parameters for Pose Control" +}, +"modelName": { +"description": "Model names, as defined in: xyz ", +"type": "string" +}, +"numDiffusionSteps": { +"description": "Number of diffusion steps", +"format": "int32", +"type": "integer" +}, +"promptInputs": { +"$ref": "CloudAiLargeModelsVisionPromptInputs", +"description": "Prompt chunks for \"ProModel\" prompting. If set, the prompt will not be rewritten, and top-level prompt ignored." +}, +"videoTransformMaskGcsUri": { +"description": "GCS URI of the grayscale video mask for Differential Diffusion. Maps to sdedit_video_tmax_scale_map ", +"type": "string" +}, +"videoTransformStrength": { +"description": "SDEdit: Scalar noise level (0.0 to 1.0) Maps to sdedit_tmax ", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, "CloudAiLargeModelsVisionGenerateVideoResponse": { "description": "Generate video response.", "id": "CloudAiLargeModelsVisionGenerateVideoResponse", @@ -38859,6 +38982,10 @@ "description": "Base64 encoded bytes string representing the video.", "type": "string" }, +"experimentsMetadata": { +"$ref": "CloudAiLargeModelsVisionGenerateVideoExperiments", +"description": "Optional metadata returned from experimental requests. Likely only includes the rewritten prompt chunks." +}, "gcsUri": { "description": "Cloud Storage URI where the generated video is written.", "type": "string" @@ -38870,6 +38997,20 @@ }, "type": "object" }, +"CloudAiLargeModelsVisionHumanPose": { +"id": "CloudAiLargeModelsVisionHumanPose", +"properties": { +"bodyLandmarksGcsUri": { +"description": "GCS URI of the human pose video to condition video generation.", +"type": "string" +}, +"faceLandmarksGcsUri": { +"description": "GCS URI of the face landmarks video to condition video generation.", +"type": "string" +} +}, +"type": "object" +}, "CloudAiLargeModelsVisionImage": { "description": "Image.", "id": "CloudAiLargeModelsVisionImage", @@ -39002,6 +39143,36 @@ }, "type": "object" }, +"CloudAiLargeModelsVisionPromptInputs": { +"description": "\"Direct\" prompting for Experimental Video Generation. These will be sent directly to the LDM without being rewritten.", +"id": "CloudAiLargeModelsVisionPromptInputs", +"properties": { +"audioPrompt": { +"description": "Description of audio content in the video, without speech.", +"type": "string" +}, +"negativeAudioPrompt": { +"description": "Negative description of audio content in the video.", +"type": "string" +}, +"negativePrompt": { +"description": "Single negative prompt for what not to generate.", +"type": "string" +}, +"promptChunks": { +"description": "2s, 256 tokens per chunk, 4 total chunks. Required.", +"items": { +"type": "string" +}, +"type": "array" +}, +"transcript": { +"description": "Spoken transcript of the video for characters.", +"type": "string" +} +}, +"type": "object" +}, "CloudAiLargeModelsVisionRaiInfo": { "description": "Next ID: 6", "id": "CloudAiLargeModelsVisionRaiInfo", @@ -39756,6 +39927,39 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1AskContextsRequest": { +"description": "Agentic Retrieval Ask API for RAG. Request message for VertexRagService.AskContexts.", +"id": "GoogleCloudAiplatformV1beta1AskContextsRequest", +"properties": { +"query": { +"$ref": "GoogleCloudAiplatformV1beta1RagQuery", +"description": "Required. Single RAG retrieve query." +}, +"tools": { +"description": "Optional. The tools to use for AskContexts.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1Tool" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1AskContextsResponse": { +"description": "Response message for VertexRagService.AskContexts.", +"id": "GoogleCloudAiplatformV1beta1AskContextsResponse", +"properties": { +"contexts": { +"$ref": "GoogleCloudAiplatformV1beta1RagContexts", +"description": "The contexts of the query." +}, +"response": { +"description": "The Retrieval Response.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1AssembleDataRequest": { "description": "Request message for DatasetService.AssembleData. Used only for MULTIMODAL datasets.", "id": "GoogleCloudAiplatformV1beta1AssembleDataRequest", @@ -39886,6 +40090,24 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1AsyncRetrieveContextsRequest": { +"description": "Request message for VertexRagService.AsyncRetrieveContexts.", +"id": "GoogleCloudAiplatformV1beta1AsyncRetrieveContextsRequest", +"properties": { +"query": { +"$ref": "GoogleCloudAiplatformV1beta1RagQuery", +"description": "Required. Single RAG retrieve query." +}, +"tools": { +"description": "Optional. The tools to use for AskContexts.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1Tool" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1Attribution": { "description": "Attribution that explains a particular prediction output.", "id": "GoogleCloudAiplatformV1beta1Attribution", @@ -44570,6 +44792,25 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1DistillationSamplingSpec": { +"description": "Spec for creating a distilled dataset in Vertex Dataset.", +"id": "GoogleCloudAiplatformV1beta1DistillationSamplingSpec", +"properties": { +"baseTeacherModel": { +"description": "Optional. The base teacher model that is being distilled. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models).", +"type": "string" +}, +"tunedTeacherModelSource": { +"description": "Optional. The resource name of the Tuned teacher model. Format: `projects/{project}/locations/{location}/models/{model}`.", +"type": "string" +}, +"validationDatasetUri": { +"description": "Optional. Cloud Storage path to file containing validation dataset for distillation. The dataset must be formatted as a JSONL file.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1DistillationSpec": { "description": "Tuning Spec for Distillation.", "id": "GoogleCloudAiplatformV1beta1DistillationSpec", @@ -44671,20 +44912,23 @@ "id": "GoogleCloudAiplatformV1beta1EmbedContentRequest", "properties": { "autoTruncate": { -"description": "Optional. Whether to silently truncate the input content if it's longer than the maximum sequence length.", +"deprecated": true, +"description": "Optional. Deprecated: Please use EmbedContentConfig.auto_truncate instead. Whether to silently truncate the input content if it's longer than the maximum sequence length.", "type": "boolean" }, "content": { "$ref": "GoogleCloudAiplatformV1beta1Content", -"description": "Required. Input content to be embedded. Required." +"description": "Required. The content to be embedded." }, "outputDimensionality": { -"description": "Optional. Optional reduced dimension for the output embedding. If set, excessive values in the output embedding are truncated from the end.", +"deprecated": true, +"description": "Optional. Deprecated: Please use EmbedContentConfig.output_dimensionality instead. Reduced dimension for the output embedding. If set, excessive values in the output embedding are truncated from the end.", "format": "int32", "type": "integer" }, "taskType": { -"description": "Optional. The task type of the embedding.", +"deprecated": true, +"description": "Optional. Deprecated: Please use EmbedContentConfig.task_type instead. The task type of the embedding.", "enum": [ "UNSPECIFIED", "RETRIEVAL_QUERY", @@ -44710,7 +44954,8 @@ "type": "string" }, "title": { -"description": "Optional. An optional title for the text.", +"deprecated": true, +"description": "Optional. Deprecated: Please use EmbedContentConfig.title instead. The title for the text.", "type": "string" } }, @@ -44730,7 +44975,7 @@ }, "usageMetadata": { "$ref": "GoogleCloudAiplatformV1beta1UsageMetadata", -"description": "Metadata about the response(s)." +"description": "Usage metadata about the response(s)." } }, "type": "object" @@ -45166,7 +45411,8 @@ "type": "string" }, "operationName": { -"description": "Output only. The operation ID of the evaluation run. Format: `projects/{project}/locations/{location}/operations/{operation_id}`.", +"deprecated": true, +"description": "Output only. Deprecated: The updated architecture uses evaluation_run instead.", "readOnly": true, "type": "string" } @@ -45594,12 +45840,12 @@ "id": "GoogleCloudAiplatformV1beta1EvaluationInstance", "properties": { "agentData": { -"$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentData", +"$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentData", "deprecated": true, -"description": "Optional. Deprecated. Use `agent_eval_data` instead. Data used for agent evaluation." +"description": "Optional. Deprecated: Use `agent_eval_data` instead. Data used for agent evaluation." }, "agentEvalData": { -"$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentData", +"$ref": "GoogleCloudAiplatformV1beta1AgentData", "description": "Optional. Data used for agent evaluation." }, "otherData": { @@ -45628,10 +45874,10 @@ }, "type": "object" }, -"GoogleCloudAiplatformV1beta1EvaluationInstanceAgentConfig": { +"GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentConfig": { "deprecated": true, -"description": "Configuration for an Agent.", -"id": "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentConfig", +"description": "Deprecated: Use `google.cloud.aiplatform.master.AgentConfig` in `agent_eval_data` instead. Configuration for an Agent.", +"id": "GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentConfig", "properties": { "agentId": { "description": "Optional. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map.", @@ -45657,7 +45903,7 @@ "type": "array" }, "tools": { -"$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentConfigTools", +"$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentConfigTools", "description": "List of tools." }, "toolsText": { @@ -45667,9 +45913,9 @@ }, "type": "object" }, -"GoogleCloudAiplatformV1beta1EvaluationInstanceAgentConfigTools": { +"GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentConfigTools": { "description": "Represents a list of tools for an agent.", -"id": "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentConfigTools", +"id": "GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentConfigTools", "properties": { "tool": { "description": "Optional. List of tools: each tool can have multiple function declarations.", @@ -45681,18 +45927,18 @@ }, "type": "object" }, -"GoogleCloudAiplatformV1beta1EvaluationInstanceAgentData": { +"GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentData": { "deprecated": true, -"description": "Contains data specific to agent evaluations.", -"id": "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentData", +"description": "Deprecated: Use `agent_eval_data` instead. Contains data specific to agent evaluations.", +"id": "GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentData", "properties": { "agentConfig": { -"$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentConfig", -"description": "Optional. Agent configuration." +"$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentConfig", +"description": "Optional. Deprecated: Use `agent_eval_data` instead. Agent configuration." }, "agents": { "additionalProperties": { -"$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentConfig" +"$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentConfig" }, "description": "Optional. The static Agent Configuration. This map defines the graph structure of the agent system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent (tools, instructions, sub-agents).", "type": "object" @@ -45700,14 +45946,14 @@ "developerInstruction": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceInstanceData", "deprecated": true, -"description": "Optional. Deprecated. A field containing instructions from the developer for the agent. Please use `agents.developer_instruction` or `turns.events.active_instruction` instead." +"description": "Optional. Deprecated: Use `agents.developer_instruction` or `turns.events.active_instruction` instead. A field containing instructions from the developer for the agent." }, "events": { -"$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentDataEvents", +"$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentDataEvents", "description": "A list of events." }, "tools": { -"$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentDataTools", +"$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentDataTools", "deprecated": true, "description": "List of tools." }, @@ -45719,16 +45965,16 @@ "turns": { "description": "Optional. The chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response).", "items": { -"$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentDataConversationTurn" +"$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentDataConversationTurn" }, "type": "array" } }, "type": "object" }, -"GoogleCloudAiplatformV1beta1EvaluationInstanceAgentDataAgentEvent": { +"GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentDataAgentEvent": { "description": "A single event in the execution trace.", -"id": "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentDataAgentEvent", +"id": "GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentDataAgentEvent", "properties": { "activeTools": { "description": "Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set.", @@ -45761,14 +46007,14 @@ }, "type": "object" }, -"GoogleCloudAiplatformV1beta1EvaluationInstanceAgentDataConversationTurn": { +"GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentDataConversationTurn": { "description": "Represents a single turn/invocation in the conversation.", -"id": "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentDataConversationTurn", +"id": "GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentDataConversationTurn", "properties": { "events": { "description": "Optional. The list of events that occurred during this turn.", "items": { -"$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentDataAgentEvent" +"$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentDataAgentEvent" }, "type": "array" }, @@ -45784,9 +46030,9 @@ }, "type": "object" }, -"GoogleCloudAiplatformV1beta1EvaluationInstanceAgentDataEvents": { +"GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentDataEvents": { "description": "Represents a list of events for an agent.", -"id": "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentDataEvents", +"id": "GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentDataEvents", "properties": { "event": { "description": "Optional. A list of events.", @@ -45798,9 +46044,9 @@ }, "type": "object" }, -"GoogleCloudAiplatformV1beta1EvaluationInstanceAgentDataTools": { -"description": "Deprecated. Represents a list of tools for an agent.", -"id": "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentDataTools", +"GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentDataTools": { +"description": "Deprecated: Use `agent_eval_data` instead. Represents a list of tools for an agent.", +"id": "GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentDataTools", "properties": { "tool": { "deprecated": true, @@ -46250,7 +46496,7 @@ "id": "GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfig", "properties": { "agentConfig": { -"$ref": "GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfigAgentConfig", +"$ref": "GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfigInferenceAgentConfig", "description": "Optional. Agent config used to generate responses." }, "generationConfig": { @@ -46264,9 +46510,9 @@ }, "type": "object" }, -"GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfigAgentConfig": { +"GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfigInferenceAgentConfig": { "description": "Configuration that describes an agent.", -"id": "GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfigAgentConfig", +"id": "GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfigInferenceAgentConfig", "properties": { "developerInstruction": { "$ref": "GoogleCloudAiplatformV1beta1Content", @@ -46625,6 +46871,10 @@ "$ref": "GoogleCloudAiplatformV1beta1GroundingMetadata", "description": "Optional. Metadata returned to client when grounding is enabled." }, +"inputTranscription": { +"$ref": "GoogleCloudAiplatformV1beta1Transcription", +"description": "Optional. Audio transcription of user input." +}, "interrupted": { "description": "Optional. Flag indicating that LLM was interrupted when generating the content. Usually it's due to user interruption during a bidi streaming.", "type": "boolean" @@ -46636,6 +46886,10 @@ }, "type": "array" }, +"outputTranscription": { +"$ref": "GoogleCloudAiplatformV1beta1Transcription", +"description": "Optional. Audio transcription of model output." +}, "partial": { "description": "Optional. Indicates whether the text content is part of a unfinished text stream. Only used for streaming mode and when the content is plain text.", "type": "boolean" @@ -50918,7 +51172,7 @@ "id": "GoogleCloudAiplatformV1beta1GenerateInstanceRubricsRequest", "properties": { "agentConfig": { -"$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentConfig", +"$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentConfig", "description": "Optional. Agent configuration, required for agent-based rubric generation." }, "contents": { @@ -51621,6 +51875,10 @@ "description": "A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information.", "id": "GoogleCloudAiplatformV1beta1GroundingChunk", "properties": { +"image": { +"$ref": "GoogleCloudAiplatformV1beta1GroundingChunkImage", +"description": "A grounding chunk from an image search result. See the `Image` message for details." +}, "maps": { "$ref": "GoogleCloudAiplatformV1beta1GroundingChunkMaps", "description": "A grounding chunk from Google Maps. See the `Maps` message for details." @@ -51636,6 +51894,29 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1GroundingChunkImage": { +"description": "An `Image` chunk is a piece of evidence that comes from an image search result. It contains the URI of the image search result and the URI of the image. This is used to provide the user with a link to the source of the information.", +"id": "GoogleCloudAiplatformV1beta1GroundingChunkImage", +"properties": { +"domain": { +"description": "The domain of the image search result page.", +"type": "string" +}, +"imageUri": { +"description": "The URI of the image.", +"type": "string" +}, +"sourceUri": { +"description": "The URI of the image search result page.", +"type": "string" +}, +"title": { +"description": "The title of the image search result page.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1GroundingChunkMaps": { "description": "A `Maps` chunk is a piece of evidence that comes from Google Maps, containing information about places or routes. This is used to provide the user with rich, location-based information.", "id": "GoogleCloudAiplatformV1beta1GroundingChunkMaps", @@ -51648,6 +51929,11 @@ "description": "This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API.", "type": "string" }, +"route": { +"$ref": "GoogleCloudAiplatformV1beta1GroundingChunkMapsRoute", +"description": "Output only. Route information.", +"readOnly": true +}, "text": { "description": "The text of the place answer.", "type": "string" @@ -51696,6 +51982,27 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1GroundingChunkMapsRoute": { +"description": "Route information from Google Maps.", +"id": "GoogleCloudAiplatformV1beta1GroundingChunkMapsRoute", +"properties": { +"distanceMeters": { +"description": "The total distance of the route, in meters.", +"format": "int32", +"type": "integer" +}, +"duration": { +"description": "The total duration of the route.", +"format": "google-duration", +"type": "string" +}, +"encodedPolyline": { +"description": "An encoded polyline of the route. See https://developers.google.com/maps/documentation/utilities/polylinealgorithm", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext": { "description": "Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset.", "id": "GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext", @@ -51766,6 +52073,13 @@ }, "type": "array" }, +"imageSearchQueries": { +"description": "Optional. The image search queries that were used to generate the content. This field is populated only when the grounding source is Google Search with the Image Search search_type enabled.", +"items": { +"type": "string" +}, +"type": "array" +}, "retrievalMetadata": { "$ref": "GoogleCloudAiplatformV1beta1RetrievalMetadata", "description": "Optional. Output only. Metadata related to the retrieval grounding source.", @@ -51816,7 +52130,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1GroundingSupport": { -"description": "A collection of supporting references for a segment of the model's response.", +"description": "A collection of supporting references for a segment or part of the model's response.", "id": "GoogleCloudAiplatformV1beta1GroundingSupport", "properties": { "confidenceScores": { @@ -51835,6 +52149,14 @@ }, "type": "array" }, +"renderedParts": { +"description": "Indices into the `rendered_parts` field of the `GroundingMetadata` message. These indices specify which rendered parts are associated with this support message.", +"items": { +"format": "int32", +"type": "integer" +}, +"type": "array" +}, "segment": { "$ref": "GoogleCloudAiplatformV1beta1Segment", "description": "The content segment that this support message applies to." @@ -52017,6 +52339,20 @@ "Prevents the model from generating images of people." ], "type": "string" +}, +"prominentPeople": { +"description": "Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people.", +"enum": [ +"PROMINENT_PEOPLE_UNSPECIFIED", +"ALLOW_PROMINENT_PEOPLE", +"BLOCK_PROMINENT_PEOPLE" +], +"enumDescriptions": [ +"Unspecified value. The model will proceed with the default behavior, which is to allow generation of prominent people.", +"Allows the model to generate images of prominent people.", +"Prevents the model from generating images of prominent people." +], +"type": "string" } }, "type": "object" @@ -52440,7 +52776,8 @@ }, "ragFileMetadataConfig": { "$ref": "GoogleCloudAiplatformV1beta1RagFileMetadataConfig", -"description": "Specifies the metadata config for RagFiles. Including paths for metadata schema and metadata." +"deprecated": true, +"description": "Specifies the metadata config for RagFiles. Including paths for metadata schema and metadata. Deprecated: Not in use." }, "ragFileParsingConfig": { "$ref": "GoogleCloudAiplatformV1beta1RagFileParsingConfig", @@ -65752,7 +66089,7 @@ false "type": "object" }, "description": { -"description": "Optional. Description of the schema.", +"description": "Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.", "type": "string" }, "enum": { @@ -73181,10 +73518,41 @@ false "type": "string" }, "type": "array" +}, +"searchTypes": { +"$ref": "GoogleCloudAiplatformV1beta1ToolGoogleSearchSearchTypes", +"description": "Optional. The set of search types to enable. If not set, web search is enabled by default." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1ToolGoogleSearchImageSearch": { +"description": "Image search for grounding and related configurations.", +"id": "GoogleCloudAiplatformV1beta1ToolGoogleSearchImageSearch", +"properties": {}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1ToolGoogleSearchSearchTypes": { +"description": "Different types of search that can be enabled on the GoogleSearch tool.", +"id": "GoogleCloudAiplatformV1beta1ToolGoogleSearchSearchTypes", +"properties": { +"imageSearch": { +"$ref": "GoogleCloudAiplatformV1beta1ToolGoogleSearchImageSearch", +"description": "Optional. Setting this field enables image search. Image bytes are returned." +}, +"webSearch": { +"$ref": "GoogleCloudAiplatformV1beta1ToolGoogleSearchWebSearch", +"description": "Optional. Setting this field enables web search. Only text results are returned." } }, "type": "object" }, +"GoogleCloudAiplatformV1beta1ToolGoogleSearchWebSearch": { +"description": "Standard web search for grounding and related configurations. Only text results are returned.", +"id": "GoogleCloudAiplatformV1beta1ToolGoogleSearchWebSearch", +"properties": {}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1ToolNameMatchInput": { "description": "Input for tool name match metric.", "id": "GoogleCloudAiplatformV1beta1ToolNameMatchInput", @@ -74009,6 +74377,21 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1Transcription": { +"description": "Audio transcription in Server Content.", +"id": "GoogleCloudAiplatformV1beta1Transcription", +"properties": { +"finished": { +"description": "Optional. The bool indicates the end of the transcription.", +"type": "boolean" +}, +"text": { +"description": "Optional. Transcription text.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1Trial": { "description": "A message representing a Trial. A Trial contains a unique set of Parameters that has been or will be evaluated, along with the objective metrics got by running the Trial.", "id": "GoogleCloudAiplatformV1beta1Trial", @@ -74249,6 +74632,10 @@ false "description": "Optional. The description of the TuningJob.", "type": "string" }, +"distillationSamplingSpec": { +"$ref": "GoogleCloudAiplatformV1beta1DistillationSamplingSpec", +"description": "Optional. Spec for creating a distillation dataset." +}, "distillationSpec": { "$ref": "GoogleCloudAiplatformV1beta1DistillationSpec", "description": "Tuning Spec for Distillation." @@ -74390,6 +74777,11 @@ false "description": "Output only. The tuning data statistics associated with this TuningJob.", "readOnly": true }, +"tuningJobMetadata": { +"$ref": "GoogleCloudAiplatformV1beta1TuningJobMetadata", +"description": "Output only. Tuning Job metadata.", +"readOnly": true +}, "tuningJobState": { "description": "Output only. The detail state of the tuning job (while the overall `JobState` is running).", "enum": [ @@ -74424,6 +74816,25 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1TuningJobMetadata": { +"description": "Tuning job metadata.", +"id": "GoogleCloudAiplatformV1beta1TuningJobMetadata", +"properties": { +"completedEpochCount": { +"description": "Output only. The number of epochs that have been completed.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"completedStepCount": { +"description": "Output only. The number of steps that have been completed. Set for Multi-Step RL.", +"format": "int64", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1UndeployIndexOperationMetadata": { "description": "Runtime operation information for IndexEndpointService.UndeployIndex.", "id": "GoogleCloudAiplatformV1beta1UndeployIndexOperationMetadata", @@ -74784,7 +75195,8 @@ false }, "ragFileMetadataConfig": { "$ref": "GoogleCloudAiplatformV1beta1RagFileMetadataConfig", -"description": "Specifies the metadata config for RagFiles. Including paths for metadata schema and metadata. Alteratively, inline metadata schema and metadata can be provided." +"deprecated": true, +"description": "Optional. Specifies the metadata config for RagFiles. Including paths for metadata schema and metadata. Alteratively, inline metadata schema and metadata can be provided. Deprecated: Not in use." }, "ragFileParsingConfig": { "$ref": "GoogleCloudAiplatformV1beta1RagFileParsingConfig", From e630a6a26516459182d2417c97bcdfdf6162f25e Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 10 Mar 2026 07:24:03 +0000 Subject: [PATCH 03/31] feat(alloydb): update the api #### alloydb:v1 The following keys were added: - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData.properties.backupRun (Total Keys: 2) - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData.properties.signalBoolValue.deprecated (Total Keys: 1) - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData.properties.signalMetadataList (Total Keys: 2) - schemas.StorageDatabasecenterPartnerapiV1mainSignalMetadata (Total Keys: 4) #### alloydb:v1alpha The following keys were added: - schemas.ObservabilityInstanceConfig.properties.trackActiveQueryPlan.type (Total Keys: 1) - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData.properties.backupRun (Total Keys: 2) - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData.properties.signalBoolValue.deprecated (Total Keys: 1) - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData.properties.signalMetadataList (Total Keys: 2) - schemas.StorageDatabasecenterPartnerapiV1mainSignalMetadata (Total Keys: 4) #### alloydb:v1beta The following keys were added: - schemas.ObservabilityInstanceConfig.properties.trackActiveQueryPlan.type (Total Keys: 1) - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData.properties.backupRun (Total Keys: 2) - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData.properties.signalBoolValue.deprecated (Total Keys: 1) - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData.properties.signalMetadataList (Total Keys: 2) - schemas.StorageDatabasecenterPartnerapiV1mainSignalMetadata (Total Keys: 4) --- ...projects.locations.clusters.instances.html | 5 ++ ...projects.locations.clusters.instances.html | 5 ++ .../discovery_cache/documents/alloydb.v1.json | 71 +++++++++++++++--- .../documents/alloydb.v1alpha.json | 75 ++++++++++++++++--- .../documents/alloydb.v1beta.json | 75 ++++++++++++++++--- 5 files changed, 198 insertions(+), 33 deletions(-) diff --git a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html index a00f2a8d03..5441308319 100644 --- a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html +++ b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html @@ -198,6 +198,7 @@

Method Details

"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. The default value is 200. Any integer between 0 to 200 is considered valid. "recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "off" by default. "trackActiveQueries": True or False, # Track actively running queries on the instance. If not set, this flag is "off" by default. + "trackActiveQueryPlan": True or False, # Indicates whether to track active query plans for an instance. If not set, the default value is "off". Can only be enabled if track_active_queries is enabled. "trackClientAddress": True or False, # Track client address for an instance. If not set, default value is "off". "trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by internal API. "trackWaitEvents": True or False, # Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. @@ -388,6 +389,7 @@

Method Details

"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. The default value is 200. Any integer between 0 to 200 is considered valid. "recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "off" by default. "trackActiveQueries": True or False, # Track actively running queries on the instance. If not set, this flag is "off" by default. + "trackActiveQueryPlan": True or False, # Indicates whether to track active query plans for an instance. If not set, the default value is "off". Can only be enabled if track_active_queries is enabled. "trackClientAddress": True or False, # Track client address for an instance. If not set, default value is "off". "trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by internal API. "trackWaitEvents": True or False, # Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. @@ -669,6 +671,7 @@

Method Details

"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. The default value is 200. Any integer between 0 to 200 is considered valid. "recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "off" by default. "trackActiveQueries": True or False, # Track actively running queries on the instance. If not set, this flag is "off" by default. + "trackActiveQueryPlan": True or False, # Indicates whether to track active query plans for an instance. If not set, the default value is "off". Can only be enabled if track_active_queries is enabled. "trackClientAddress": True or False, # Track client address for an instance. If not set, default value is "off". "trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by internal API. "trackWaitEvents": True or False, # Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. @@ -910,6 +913,7 @@

Method Details

"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. The default value is 200. Any integer between 0 to 200 is considered valid. "recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "off" by default. "trackActiveQueries": True or False, # Track actively running queries on the instance. If not set, this flag is "off" by default. + "trackActiveQueryPlan": True or False, # Indicates whether to track active query plans for an instance. If not set, the default value is "off". Can only be enabled if track_active_queries is enabled. "trackClientAddress": True or False, # Track client address for an instance. If not set, default value is "off". "trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by internal API. "trackWaitEvents": True or False, # Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. @@ -1089,6 +1093,7 @@

Method Details

"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. The default value is 200. Any integer between 0 to 200 is considered valid. "recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "off" by default. "trackActiveQueries": True or False, # Track actively running queries on the instance. If not set, this flag is "off" by default. + "trackActiveQueryPlan": True or False, # Indicates whether to track active query plans for an instance. If not set, the default value is "off". Can only be enabled if track_active_queries is enabled. "trackClientAddress": True or False, # Track client address for an instance. If not set, default value is "off". "trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by internal API. "trackWaitEvents": True or False, # Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. diff --git a/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html b/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html index ec0f539ca9..9ae6ac47c4 100644 --- a/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html +++ b/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html @@ -198,6 +198,7 @@

Method Details

"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. The default value is 200. Any integer between 0 to 200 is considered valid. "recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "off" by default. "trackActiveQueries": True or False, # Track actively running queries on the instance. If not set, this flag is "off" by default. + "trackActiveQueryPlan": True or False, # Indicates whether to track active query plans for an instance. If not set, the default value is "off". Can only be enabled if track_active_queries is enabled. "trackClientAddress": True or False, # Track client address for an instance. If not set, default value is "off". "trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by internal API. "trackWaitEvents": True or False, # Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. @@ -387,6 +388,7 @@

Method Details

"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. The default value is 200. Any integer between 0 to 200 is considered valid. "recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "off" by default. "trackActiveQueries": True or False, # Track actively running queries on the instance. If not set, this flag is "off" by default. + "trackActiveQueryPlan": True or False, # Indicates whether to track active query plans for an instance. If not set, the default value is "off". Can only be enabled if track_active_queries is enabled. "trackClientAddress": True or False, # Track client address for an instance. If not set, default value is "off". "trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by internal API. "trackWaitEvents": True or False, # Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. @@ -667,6 +669,7 @@

Method Details

"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. The default value is 200. Any integer between 0 to 200 is considered valid. "recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "off" by default. "trackActiveQueries": True or False, # Track actively running queries on the instance. If not set, this flag is "off" by default. + "trackActiveQueryPlan": True or False, # Indicates whether to track active query plans for an instance. If not set, the default value is "off". Can only be enabled if track_active_queries is enabled. "trackClientAddress": True or False, # Track client address for an instance. If not set, default value is "off". "trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by internal API. "trackWaitEvents": True or False, # Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. @@ -907,6 +910,7 @@

Method Details

"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. The default value is 200. Any integer between 0 to 200 is considered valid. "recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "off" by default. "trackActiveQueries": True or False, # Track actively running queries on the instance. If not set, this flag is "off" by default. + "trackActiveQueryPlan": True or False, # Indicates whether to track active query plans for an instance. If not set, the default value is "off". Can only be enabled if track_active_queries is enabled. "trackClientAddress": True or False, # Track client address for an instance. If not set, default value is "off". "trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by internal API. "trackWaitEvents": True or False, # Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. @@ -1085,6 +1089,7 @@

Method Details

"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. The default value is 200. Any integer between 0 to 200 is considered valid. "recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "off" by default. "trackActiveQueries": True or False, # Track actively running queries on the instance. If not set, this flag is "off" by default. + "trackActiveQueryPlan": True or False, # Indicates whether to track active query plans for an instance. If not set, the default value is "off". Can only be enabled if track_active_queries is enabled. "trackClientAddress": True or False, # Track client address for an instance. If not set, default value is "off". "trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by internal API. "trackWaitEvents": True or False, # Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1.json b/googleapiclient/discovery_cache/documents/alloydb.v1.json index 38963fa7f4..c18e4406ec 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1.json @@ -1879,7 +1879,7 @@ } } }, -"revision": "20260219", +"revision": "20260226", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -4660,7 +4660,10 @@ false "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS", "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS", "SIGNAL_TYPE_EXTENDED_SUPPORT", -"SIGNAL_TYPE_NO_AUTOMATED_BACKUP_POLICY" +"SIGNAL_TYPE_NO_AUTOMATED_BACKUP_POLICY", +"SIGNAL_TYPE_VERSION_NEARING_END_OF_LIFE", +"SIGNAL_TYPE_LAST_BACKUP_OLD", +"SIGNAL_TYPE_NOT_PROTECTED_BY_AUTOMATIC_FAILOVER" ], "enumDescriptions": [ "Unspecified signal type.", @@ -4670,7 +4673,10 @@ false "Represents if a resource is exposed to public access.", "Represents if a resources requires all incoming connections to use SSL or not.", "Represents if a resource version is in extended support.", -"Represents if a resource has no automated backup policy." +"Represents if a resource has no automated backup policy.", +"Represents if a resource version is nearing end of life.", +"Represents if the last backup of a resource is older than 24 hours.", +"Represents if a resource is not protected by automatic failover." ], "type": "string" } @@ -4980,7 +4986,8 @@ false "SIGNAL_TYPE_DATABOOST_DISABLED", "SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES", "SIGNAL_TYPE_EXTENDED_SUPPORT", -"SIGNAL_TYPE_PERFORMANCE_KPI_CHANGE" +"SIGNAL_TYPE_PERFORMANCE_KPI_CHANGE", +"SIGNAL_TYPE_VERSION_NEARING_END_OF_LIFE" ], "enumDeprecated": [ false, @@ -5088,6 +5095,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -5196,7 +5204,8 @@ false "Databoost is disabled.", "Recommended maintenance policy.", "Resource version is in extended support.", -"Change in performance KPIs." +"Change in performance KPIs.", +"Database version nearing end of life." ], "type": "string" }, @@ -5377,6 +5386,7 @@ false "SUB_RESOURCE_TYPE_SECONDARY", "SUB_RESOURCE_TYPE_READ_REPLICA", "SUB_RESOURCE_TYPE_EXTERNAL_PRIMARY", +"SUB_RESOURCE_TYPE_READ_POOL", "SUB_RESOURCE_TYPE_OTHER" ], "enumDeprecated": [ @@ -5390,6 +5400,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -5403,6 +5414,7 @@ false "A cluster or an instance acting as a secondary.", "An instance acting as a read-replica.", "An instance acting as an external primary.", +"An instance acting as Read Pool.", "For rest of the other categories." ], "type": "string" @@ -5653,7 +5665,8 @@ false "SIGNAL_TYPE_DATABOOST_DISABLED", "SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES", "SIGNAL_TYPE_EXTENDED_SUPPORT", -"SIGNAL_TYPE_PERFORMANCE_KPI_CHANGE" +"SIGNAL_TYPE_PERFORMANCE_KPI_CHANGE", +"SIGNAL_TYPE_VERSION_NEARING_END_OF_LIFE" ], "enumDeprecated": [ false, @@ -5761,6 +5774,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -5869,7 +5883,8 @@ false "Databoost is disabled.", "Recommended maintenance policy.", "Resource version is in extended support.", -"Change in performance KPIs." +"Change in performance KPIs.", +"Database version nearing end of life." ], "type": "string" } @@ -5877,9 +5892,14 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData": { -"description": "Database resource signal data. This is used to send signals to Condor which are based on the DB/Instance/Fleet level configurations. These will be used to send signals for all inventory types. Next ID: 7", +"description": "Database resource signal data. This is used to send signals to Condor which are based on the DB/Instance/Fleet level configurations. These will be used to send signals for all inventory types. Next ID: 9", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData", "properties": { +"backupRun": { +"$ref": "StorageDatabasecenterPartnerapiV1mainBackupRun", +"deprecated": true, +"description": "Deprecated: Use signal_metadata_list instead." +}, "fullResourceName": { "description": "Required. Full Resource name of the source resource.", "type": "string" @@ -5894,9 +5914,17 @@ false "description": "Database resource id." }, "signalBoolValue": { -"description": "Signal data for boolean signals.", +"deprecated": true, +"description": "Deprecated: Use signal_metadata_list instead.", "type": "boolean" }, +"signalMetadataList": { +"description": "This will support array of OneOf signal metadata information for a given signal type.", +"items": { +"$ref": "StorageDatabasecenterPartnerapiV1mainSignalMetadata" +}, +"type": "array" +}, "signalState": { "description": "Required. Output only. Signal state of the signal", "enum": [ @@ -5924,7 +5952,10 @@ false "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS", "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS", "SIGNAL_TYPE_EXTENDED_SUPPORT", -"SIGNAL_TYPE_NO_AUTOMATED_BACKUP_POLICY" +"SIGNAL_TYPE_NO_AUTOMATED_BACKUP_POLICY", +"SIGNAL_TYPE_VERSION_NEARING_END_OF_LIFE", +"SIGNAL_TYPE_LAST_BACKUP_OLD", +"SIGNAL_TYPE_NOT_PROTECTED_BY_AUTOMATIC_FAILOVER" ], "enumDescriptions": [ "Unspecified signal type.", @@ -5934,7 +5965,10 @@ false "Represents if a resource is exposed to public access.", "Represents if a resources requires all incoming connections to use SSL or not.", "Represents if a resource version is in extended support.", -"Represents if a resource has no automated backup policy." +"Represents if a resource has no automated backup policy.", +"Represents if a resource version is nearing end of life.", +"Represents if the last backup of a resource is older than 24 hours.", +"Represents if a resource is not protected by automatic failover." ], "type": "string" } @@ -6349,6 +6383,21 @@ false }, "type": "object" }, +"StorageDatabasecenterPartnerapiV1mainSignalMetadata": { +"description": "SignalMetadata contains one of the signal metadata proto messages associated with a SignalType. This proto will be mapped to SignalMetadata message in storage.proto. Next ID: 3", +"id": "StorageDatabasecenterPartnerapiV1mainSignalMetadata", +"properties": { +"backupRun": { +"$ref": "StorageDatabasecenterPartnerapiV1mainBackupRun", +"description": "Signal data for backup runs." +}, +"signalBoolValue": { +"description": "Signal data for boolean signals.", +"type": "boolean" +} +}, +"type": "object" +}, "StorageDatabasecenterPartnerapiV1mainTags": { "description": "Message type for storing tags. Tags provide a way to create annotations for resources, and in some cases conditionally allow or deny policies based on whether a resource has a specific tag.", "id": "StorageDatabasecenterPartnerapiV1mainTags", diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json b/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json index 11fdfdd914..378c8d22bd 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json @@ -1879,7 +1879,7 @@ } } }, -"revision": "20260213", +"revision": "20260226", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -3947,6 +3947,10 @@ false "description": "Track actively running queries on the instance. If not set, this flag is \"off\" by default.", "type": "boolean" }, +"trackActiveQueryPlan": { +"description": "Indicates whether to track active query plans for an instance. If not set, the default value is \"off\". Can only be enabled if track_active_queries is enabled.", +"type": "boolean" +}, "trackClientAddress": { "description": "Track client address for an instance. If not set, default value is \"off\".", "type": "boolean" @@ -4845,7 +4849,10 @@ false "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS", "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS", "SIGNAL_TYPE_EXTENDED_SUPPORT", -"SIGNAL_TYPE_NO_AUTOMATED_BACKUP_POLICY" +"SIGNAL_TYPE_NO_AUTOMATED_BACKUP_POLICY", +"SIGNAL_TYPE_VERSION_NEARING_END_OF_LIFE", +"SIGNAL_TYPE_LAST_BACKUP_OLD", +"SIGNAL_TYPE_NOT_PROTECTED_BY_AUTOMATIC_FAILOVER" ], "enumDescriptions": [ "Unspecified signal type.", @@ -4855,7 +4862,10 @@ false "Represents if a resource is exposed to public access.", "Represents if a resources requires all incoming connections to use SSL or not.", "Represents if a resource version is in extended support.", -"Represents if a resource has no automated backup policy." +"Represents if a resource has no automated backup policy.", +"Represents if a resource version is nearing end of life.", +"Represents if the last backup of a resource is older than 24 hours.", +"Represents if a resource is not protected by automatic failover." ], "type": "string" } @@ -5165,7 +5175,8 @@ false "SIGNAL_TYPE_DATABOOST_DISABLED", "SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES", "SIGNAL_TYPE_EXTENDED_SUPPORT", -"SIGNAL_TYPE_PERFORMANCE_KPI_CHANGE" +"SIGNAL_TYPE_PERFORMANCE_KPI_CHANGE", +"SIGNAL_TYPE_VERSION_NEARING_END_OF_LIFE" ], "enumDeprecated": [ false, @@ -5273,6 +5284,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -5381,7 +5393,8 @@ false "Databoost is disabled.", "Recommended maintenance policy.", "Resource version is in extended support.", -"Change in performance KPIs." +"Change in performance KPIs.", +"Database version nearing end of life." ], "type": "string" }, @@ -5562,6 +5575,7 @@ false "SUB_RESOURCE_TYPE_SECONDARY", "SUB_RESOURCE_TYPE_READ_REPLICA", "SUB_RESOURCE_TYPE_EXTERNAL_PRIMARY", +"SUB_RESOURCE_TYPE_READ_POOL", "SUB_RESOURCE_TYPE_OTHER" ], "enumDeprecated": [ @@ -5575,6 +5589,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -5588,6 +5603,7 @@ false "A cluster or an instance acting as a secondary.", "An instance acting as a read-replica.", "An instance acting as an external primary.", +"An instance acting as Read Pool.", "For rest of the other categories." ], "type": "string" @@ -5838,7 +5854,8 @@ false "SIGNAL_TYPE_DATABOOST_DISABLED", "SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES", "SIGNAL_TYPE_EXTENDED_SUPPORT", -"SIGNAL_TYPE_PERFORMANCE_KPI_CHANGE" +"SIGNAL_TYPE_PERFORMANCE_KPI_CHANGE", +"SIGNAL_TYPE_VERSION_NEARING_END_OF_LIFE" ], "enumDeprecated": [ false, @@ -5946,6 +5963,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -6054,7 +6072,8 @@ false "Databoost is disabled.", "Recommended maintenance policy.", "Resource version is in extended support.", -"Change in performance KPIs." +"Change in performance KPIs.", +"Database version nearing end of life." ], "type": "string" } @@ -6062,9 +6081,14 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData": { -"description": "Database resource signal data. This is used to send signals to Condor which are based on the DB/Instance/Fleet level configurations. These will be used to send signals for all inventory types. Next ID: 7", +"description": "Database resource signal data. This is used to send signals to Condor which are based on the DB/Instance/Fleet level configurations. These will be used to send signals for all inventory types. Next ID: 9", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData", "properties": { +"backupRun": { +"$ref": "StorageDatabasecenterPartnerapiV1mainBackupRun", +"deprecated": true, +"description": "Deprecated: Use signal_metadata_list instead." +}, "fullResourceName": { "description": "Required. Full Resource name of the source resource.", "type": "string" @@ -6079,9 +6103,17 @@ false "description": "Database resource id." }, "signalBoolValue": { -"description": "Signal data for boolean signals.", +"deprecated": true, +"description": "Deprecated: Use signal_metadata_list instead.", "type": "boolean" }, +"signalMetadataList": { +"description": "This will support array of OneOf signal metadata information for a given signal type.", +"items": { +"$ref": "StorageDatabasecenterPartnerapiV1mainSignalMetadata" +}, +"type": "array" +}, "signalState": { "description": "Required. Output only. Signal state of the signal", "enum": [ @@ -6109,7 +6141,10 @@ false "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS", "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS", "SIGNAL_TYPE_EXTENDED_SUPPORT", -"SIGNAL_TYPE_NO_AUTOMATED_BACKUP_POLICY" +"SIGNAL_TYPE_NO_AUTOMATED_BACKUP_POLICY", +"SIGNAL_TYPE_VERSION_NEARING_END_OF_LIFE", +"SIGNAL_TYPE_LAST_BACKUP_OLD", +"SIGNAL_TYPE_NOT_PROTECTED_BY_AUTOMATIC_FAILOVER" ], "enumDescriptions": [ "Unspecified signal type.", @@ -6119,7 +6154,10 @@ false "Represents if a resource is exposed to public access.", "Represents if a resources requires all incoming connections to use SSL or not.", "Represents if a resource version is in extended support.", -"Represents if a resource has no automated backup policy." +"Represents if a resource has no automated backup policy.", +"Represents if a resource version is nearing end of life.", +"Represents if the last backup of a resource is older than 24 hours.", +"Represents if a resource is not protected by automatic failover." ], "type": "string" } @@ -6534,6 +6572,21 @@ false }, "type": "object" }, +"StorageDatabasecenterPartnerapiV1mainSignalMetadata": { +"description": "SignalMetadata contains one of the signal metadata proto messages associated with a SignalType. This proto will be mapped to SignalMetadata message in storage.proto. Next ID: 3", +"id": "StorageDatabasecenterPartnerapiV1mainSignalMetadata", +"properties": { +"backupRun": { +"$ref": "StorageDatabasecenterPartnerapiV1mainBackupRun", +"description": "Signal data for backup runs." +}, +"signalBoolValue": { +"description": "Signal data for boolean signals.", +"type": "boolean" +} +}, +"type": "object" +}, "StorageDatabasecenterPartnerapiV1mainTags": { "description": "Message type for storing tags. Tags provide a way to create annotations for resources, and in some cases conditionally allow or deny policies based on whether a resource has a specific tag.", "id": "StorageDatabasecenterPartnerapiV1mainTags", diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1beta.json b/googleapiclient/discovery_cache/documents/alloydb.v1beta.json index 4313d5724b..69753507c1 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1beta.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1beta.json @@ -1876,7 +1876,7 @@ } } }, -"revision": "20260213", +"revision": "20260226", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -3923,6 +3923,10 @@ false "description": "Track actively running queries on the instance. If not set, this flag is \"off\" by default.", "type": "boolean" }, +"trackActiveQueryPlan": { +"description": "Indicates whether to track active query plans for an instance. If not set, the default value is \"off\". Can only be enabled if track_active_queries is enabled.", +"type": "boolean" +}, "trackClientAddress": { "description": "Track client address for an instance. If not set, default value is \"off\".", "type": "boolean" @@ -4821,7 +4825,10 @@ false "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS", "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS", "SIGNAL_TYPE_EXTENDED_SUPPORT", -"SIGNAL_TYPE_NO_AUTOMATED_BACKUP_POLICY" +"SIGNAL_TYPE_NO_AUTOMATED_BACKUP_POLICY", +"SIGNAL_TYPE_VERSION_NEARING_END_OF_LIFE", +"SIGNAL_TYPE_LAST_BACKUP_OLD", +"SIGNAL_TYPE_NOT_PROTECTED_BY_AUTOMATIC_FAILOVER" ], "enumDescriptions": [ "Unspecified signal type.", @@ -4831,7 +4838,10 @@ false "Represents if a resource is exposed to public access.", "Represents if a resources requires all incoming connections to use SSL or not.", "Represents if a resource version is in extended support.", -"Represents if a resource has no automated backup policy." +"Represents if a resource has no automated backup policy.", +"Represents if a resource version is nearing end of life.", +"Represents if the last backup of a resource is older than 24 hours.", +"Represents if a resource is not protected by automatic failover." ], "type": "string" } @@ -5141,7 +5151,8 @@ false "SIGNAL_TYPE_DATABOOST_DISABLED", "SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES", "SIGNAL_TYPE_EXTENDED_SUPPORT", -"SIGNAL_TYPE_PERFORMANCE_KPI_CHANGE" +"SIGNAL_TYPE_PERFORMANCE_KPI_CHANGE", +"SIGNAL_TYPE_VERSION_NEARING_END_OF_LIFE" ], "enumDeprecated": [ false, @@ -5249,6 +5260,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -5357,7 +5369,8 @@ false "Databoost is disabled.", "Recommended maintenance policy.", "Resource version is in extended support.", -"Change in performance KPIs." +"Change in performance KPIs.", +"Database version nearing end of life." ], "type": "string" }, @@ -5538,6 +5551,7 @@ false "SUB_RESOURCE_TYPE_SECONDARY", "SUB_RESOURCE_TYPE_READ_REPLICA", "SUB_RESOURCE_TYPE_EXTERNAL_PRIMARY", +"SUB_RESOURCE_TYPE_READ_POOL", "SUB_RESOURCE_TYPE_OTHER" ], "enumDeprecated": [ @@ -5551,6 +5565,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -5564,6 +5579,7 @@ false "A cluster or an instance acting as a secondary.", "An instance acting as a read-replica.", "An instance acting as an external primary.", +"An instance acting as Read Pool.", "For rest of the other categories." ], "type": "string" @@ -5814,7 +5830,8 @@ false "SIGNAL_TYPE_DATABOOST_DISABLED", "SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES", "SIGNAL_TYPE_EXTENDED_SUPPORT", -"SIGNAL_TYPE_PERFORMANCE_KPI_CHANGE" +"SIGNAL_TYPE_PERFORMANCE_KPI_CHANGE", +"SIGNAL_TYPE_VERSION_NEARING_END_OF_LIFE" ], "enumDeprecated": [ false, @@ -5922,6 +5939,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -6030,7 +6048,8 @@ false "Databoost is disabled.", "Recommended maintenance policy.", "Resource version is in extended support.", -"Change in performance KPIs." +"Change in performance KPIs.", +"Database version nearing end of life." ], "type": "string" } @@ -6038,9 +6057,14 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData": { -"description": "Database resource signal data. This is used to send signals to Condor which are based on the DB/Instance/Fleet level configurations. These will be used to send signals for all inventory types. Next ID: 7", +"description": "Database resource signal data. This is used to send signals to Condor which are based on the DB/Instance/Fleet level configurations. These will be used to send signals for all inventory types. Next ID: 9", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData", "properties": { +"backupRun": { +"$ref": "StorageDatabasecenterPartnerapiV1mainBackupRun", +"deprecated": true, +"description": "Deprecated: Use signal_metadata_list instead." +}, "fullResourceName": { "description": "Required. Full Resource name of the source resource.", "type": "string" @@ -6055,9 +6079,17 @@ false "description": "Database resource id." }, "signalBoolValue": { -"description": "Signal data for boolean signals.", +"deprecated": true, +"description": "Deprecated: Use signal_metadata_list instead.", "type": "boolean" }, +"signalMetadataList": { +"description": "This will support array of OneOf signal metadata information for a given signal type.", +"items": { +"$ref": "StorageDatabasecenterPartnerapiV1mainSignalMetadata" +}, +"type": "array" +}, "signalState": { "description": "Required. Output only. Signal state of the signal", "enum": [ @@ -6085,7 +6117,10 @@ false "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS", "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS", "SIGNAL_TYPE_EXTENDED_SUPPORT", -"SIGNAL_TYPE_NO_AUTOMATED_BACKUP_POLICY" +"SIGNAL_TYPE_NO_AUTOMATED_BACKUP_POLICY", +"SIGNAL_TYPE_VERSION_NEARING_END_OF_LIFE", +"SIGNAL_TYPE_LAST_BACKUP_OLD", +"SIGNAL_TYPE_NOT_PROTECTED_BY_AUTOMATIC_FAILOVER" ], "enumDescriptions": [ "Unspecified signal type.", @@ -6095,7 +6130,10 @@ false "Represents if a resource is exposed to public access.", "Represents if a resources requires all incoming connections to use SSL or not.", "Represents if a resource version is in extended support.", -"Represents if a resource has no automated backup policy." +"Represents if a resource has no automated backup policy.", +"Represents if a resource version is nearing end of life.", +"Represents if the last backup of a resource is older than 24 hours.", +"Represents if a resource is not protected by automatic failover." ], "type": "string" } @@ -6510,6 +6548,21 @@ false }, "type": "object" }, +"StorageDatabasecenterPartnerapiV1mainSignalMetadata": { +"description": "SignalMetadata contains one of the signal metadata proto messages associated with a SignalType. This proto will be mapped to SignalMetadata message in storage.proto. Next ID: 3", +"id": "StorageDatabasecenterPartnerapiV1mainSignalMetadata", +"properties": { +"backupRun": { +"$ref": "StorageDatabasecenterPartnerapiV1mainBackupRun", +"description": "Signal data for backup runs." +}, +"signalBoolValue": { +"description": "Signal data for boolean signals.", +"type": "boolean" +} +}, +"type": "object" +}, "StorageDatabasecenterPartnerapiV1mainTags": { "description": "Message type for storing tags. Tags provide a way to create annotations for resources, and in some cases conditionally allow or deny policies based on whether a resource has a specific tag.", "id": "StorageDatabasecenterPartnerapiV1mainTags", From 0da0a8095c028689210816c4ee41327c2375cb7b Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 10 Mar 2026 07:24:03 +0000 Subject: [PATCH 04/31] feat(androidmanagement): update the api #### androidmanagement:v1 The following keys were deleted: - schemas.SystemUpdate.properties.allowedDaysWithoutUpdate (Total Keys: 2) --- ...roidmanagement_v1.enterprises.policies.html | 18 ++++++------------ .../documents/androidmanagement.v1.json | 11 +++-------- 2 files changed, 9 insertions(+), 20 deletions(-) diff --git a/docs/dyn/androidmanagement_v1.enterprises.policies.html b/docs/dyn/androidmanagement_v1.enterprises.policies.html index ab2f49621f..5af5524096 100644 --- a/docs/dyn/androidmanagement_v1.enterprises.policies.html +++ b/docs/dyn/androidmanagement_v1.enterprises.policies.html @@ -338,7 +338,7 @@

Method Details

], }, "privateDnsSettings": { # Controls the device's private DNS settings. # Optional. The global private DNS settings. - "privateDnsHost": "A String", # Optional. The hostname of the DNS server. This must be set if and only if private_dns_mode is set to PRIVATE_DNS_SPECIFIED_HOST. Supported on Android 10 and above on fully managed devices. A NonComplianceDetail with MANAGEMENT_MODE is reported on other management modes. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 10. A NonComplianceDetail with PENDING is reported if the device is not connected to a network. A NonComplianceDetail with nonComplianceReason INVALID_VALUE and specificNonComplianceReason PRIVATE_DNS_HOST_NOT_SERVING is reported if the specified host is not a DNS server or not supported on Android. A NonComplianceReason with nonComplianceReason INVALID_VALUE is reported if applying this setting fails for any other reason. + "privateDnsHost": "A String", # Optional. The hostname of the DNS server. This must be set if and only if private_dns_mode is set to PRIVATE_DNS_SPECIFIED_HOST. Supported on Android 10 and above on fully managed devices. A NonComplianceDetail with MANAGEMENT_MODE is reported on other management modes. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 10. A NonComplianceDetail with PENDING is reported if the device is not connected to a network. A NonComplianceDetail with nonComplianceReason INVALID_VALUE and specificNonComplianceReason PRIVATE_DNS_HOST_NOT_SERVING is reported if the specified host is not a DNS server or not supported on Android. A NonComplianceDetail with INVALID_VALUE is reported if applying this setting fails for any other reason. "privateDnsMode": "A String", # Optional. The configuration mode for device's global private DNS settings. If this is set to PRIVATE_DNS_SPECIFIED_HOST, then private_dns_host must be set. }, "tetheringSettings": "A String", # Controls tethering settings. Based on the value set, the user is partially or fully disallowed from using different forms of tethering. @@ -599,7 +599,6 @@

Method Details

"A String", ], "systemUpdate": { # Configuration for managing system updatesNote: Google Play system updates (https://source.android.com/docs/core/ota/modular-system) (also called Mainline updates) are automatically downloaded but require a device reboot to be installed. Refer to the mainline section in Manage system updates (https://developer.android.com/work/dpc/system-updates#mainline) for further details. # The system update policy, which controls how OS updates are applied. If the update type is WINDOWED, the update window will automatically apply to Play app updates as well.Note: Google Play system updates (https://source.android.com/docs/core/ota/modular-system) (also called Mainline updates) are automatically downloaded and require a device reboot to be installed. Refer to the mainline section in Manage system updates (https://developer.android.com/work/dpc/system-updates#mainline) for further details. - "allowedDaysWithoutUpdate": 42, # If this is greater than zero, then this is the number of days after a pending update becoming available that a device can remain compliant, without taking the update. Has no effect otherwise. "endMinutes": 42, # If the type is WINDOWED, the end of the maintenance window, measured as the number of minutes after midnight in device's local time. This value must be between 0 and 1439, inclusive. If this value is less than start_minutes, then the maintenance window spans midnight. If the maintenance window specified is smaller than 30 minutes, the actual window is extended to 30 minutes beyond the start time. "freezePeriods": [ # An annually repeating time period in which over-the-air (OTA) system updates are postponed to freeze the OS version running on a device. To prevent freezing the device indefinitely, each freeze period must be separated by at least 60 days. { # A system freeze period. When a device’s clock is within the freeze period, all incoming system updates (including security patches) are blocked and won’t be installed.When the device is outside any set freeze periods, the normal policy behavior (automatic, windowed, or postponed) applies.Leap years are ignored in freeze period calculations, in particular: If Feb. 29th is set as the start or end date of a freeze period, the freeze period will start or end on Feb. 28th instead. When a device’s system clock reads Feb. 29th, it’s treated as Feb. 28th. When calculating the number of days in a freeze period or the time between two freeze periods, Feb. 29th is ignored and not counted as a day.Note: For Freeze Periods to take effect, SystemUpdateType cannot be specified as SYSTEM_UPDATE_TYPE_UNSPECIFIED, because freeze periods require a defined policy to be specified. @@ -866,7 +865,7 @@

Method Details

], }, "privateDnsSettings": { # Controls the device's private DNS settings. # Optional. The global private DNS settings. - "privateDnsHost": "A String", # Optional. The hostname of the DNS server. This must be set if and only if private_dns_mode is set to PRIVATE_DNS_SPECIFIED_HOST. Supported on Android 10 and above on fully managed devices. A NonComplianceDetail with MANAGEMENT_MODE is reported on other management modes. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 10. A NonComplianceDetail with PENDING is reported if the device is not connected to a network. A NonComplianceDetail with nonComplianceReason INVALID_VALUE and specificNonComplianceReason PRIVATE_DNS_HOST_NOT_SERVING is reported if the specified host is not a DNS server or not supported on Android. A NonComplianceReason with nonComplianceReason INVALID_VALUE is reported if applying this setting fails for any other reason. + "privateDnsHost": "A String", # Optional. The hostname of the DNS server. This must be set if and only if private_dns_mode is set to PRIVATE_DNS_SPECIFIED_HOST. Supported on Android 10 and above on fully managed devices. A NonComplianceDetail with MANAGEMENT_MODE is reported on other management modes. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 10. A NonComplianceDetail with PENDING is reported if the device is not connected to a network. A NonComplianceDetail with nonComplianceReason INVALID_VALUE and specificNonComplianceReason PRIVATE_DNS_HOST_NOT_SERVING is reported if the specified host is not a DNS server or not supported on Android. A NonComplianceDetail with INVALID_VALUE is reported if applying this setting fails for any other reason. "privateDnsMode": "A String", # Optional. The configuration mode for device's global private DNS settings. If this is set to PRIVATE_DNS_SPECIFIED_HOST, then private_dns_host must be set. }, "tetheringSettings": "A String", # Controls tethering settings. Based on the value set, the user is partially or fully disallowed from using different forms of tethering. @@ -1127,7 +1126,6 @@

Method Details

"A String", ], "systemUpdate": { # Configuration for managing system updatesNote: Google Play system updates (https://source.android.com/docs/core/ota/modular-system) (also called Mainline updates) are automatically downloaded but require a device reboot to be installed. Refer to the mainline section in Manage system updates (https://developer.android.com/work/dpc/system-updates#mainline) for further details. # The system update policy, which controls how OS updates are applied. If the update type is WINDOWED, the update window will automatically apply to Play app updates as well.Note: Google Play system updates (https://source.android.com/docs/core/ota/modular-system) (also called Mainline updates) are automatically downloaded and require a device reboot to be installed. Refer to the mainline section in Manage system updates (https://developer.android.com/work/dpc/system-updates#mainline) for further details. - "allowedDaysWithoutUpdate": 42, # If this is greater than zero, then this is the number of days after a pending update becoming available that a device can remain compliant, without taking the update. Has no effect otherwise. "endMinutes": 42, # If the type is WINDOWED, the end of the maintenance window, measured as the number of minutes after midnight in device's local time. This value must be between 0 and 1439, inclusive. If this value is less than start_minutes, then the maintenance window spans midnight. If the maintenance window specified is smaller than 30 minutes, the actual window is extended to 30 minutes beyond the start time. "freezePeriods": [ # An annually repeating time period in which over-the-air (OTA) system updates are postponed to freeze the OS version running on a device. To prevent freezing the device indefinitely, each freeze period must be separated by at least 60 days. { # A system freeze period. When a device’s clock is within the freeze period, all incoming system updates (including security patches) are blocked and won’t be installed.When the device is outside any set freeze periods, the normal policy behavior (automatic, windowed, or postponed) applies.Leap years are ignored in freeze period calculations, in particular: If Feb. 29th is set as the start or end date of a freeze period, the freeze period will start or end on Feb. 28th instead. When a device’s system clock reads Feb. 29th, it’s treated as Feb. 28th. When calculating the number of days in a freeze period or the time between two freeze periods, Feb. 29th is ignored and not counted as a day.Note: For Freeze Periods to take effect, SystemUpdateType cannot be specified as SYSTEM_UPDATE_TYPE_UNSPECIFIED, because freeze periods require a defined policy to be specified. @@ -1480,7 +1478,7 @@

Method Details

], }, "privateDnsSettings": { # Controls the device's private DNS settings. # Optional. The global private DNS settings. - "privateDnsHost": "A String", # Optional. The hostname of the DNS server. This must be set if and only if private_dns_mode is set to PRIVATE_DNS_SPECIFIED_HOST. Supported on Android 10 and above on fully managed devices. A NonComplianceDetail with MANAGEMENT_MODE is reported on other management modes. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 10. A NonComplianceDetail with PENDING is reported if the device is not connected to a network. A NonComplianceDetail with nonComplianceReason INVALID_VALUE and specificNonComplianceReason PRIVATE_DNS_HOST_NOT_SERVING is reported if the specified host is not a DNS server or not supported on Android. A NonComplianceReason with nonComplianceReason INVALID_VALUE is reported if applying this setting fails for any other reason. + "privateDnsHost": "A String", # Optional. The hostname of the DNS server. This must be set if and only if private_dns_mode is set to PRIVATE_DNS_SPECIFIED_HOST. Supported on Android 10 and above on fully managed devices. A NonComplianceDetail with MANAGEMENT_MODE is reported on other management modes. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 10. A NonComplianceDetail with PENDING is reported if the device is not connected to a network. A NonComplianceDetail with nonComplianceReason INVALID_VALUE and specificNonComplianceReason PRIVATE_DNS_HOST_NOT_SERVING is reported if the specified host is not a DNS server or not supported on Android. A NonComplianceDetail with INVALID_VALUE is reported if applying this setting fails for any other reason. "privateDnsMode": "A String", # Optional. The configuration mode for device's global private DNS settings. If this is set to PRIVATE_DNS_SPECIFIED_HOST, then private_dns_host must be set. }, "tetheringSettings": "A String", # Controls tethering settings. Based on the value set, the user is partially or fully disallowed from using different forms of tethering. @@ -1741,7 +1739,6 @@

Method Details

"A String", ], "systemUpdate": { # Configuration for managing system updatesNote: Google Play system updates (https://source.android.com/docs/core/ota/modular-system) (also called Mainline updates) are automatically downloaded but require a device reboot to be installed. Refer to the mainline section in Manage system updates (https://developer.android.com/work/dpc/system-updates#mainline) for further details. # The system update policy, which controls how OS updates are applied. If the update type is WINDOWED, the update window will automatically apply to Play app updates as well.Note: Google Play system updates (https://source.android.com/docs/core/ota/modular-system) (also called Mainline updates) are automatically downloaded and require a device reboot to be installed. Refer to the mainline section in Manage system updates (https://developer.android.com/work/dpc/system-updates#mainline) for further details. - "allowedDaysWithoutUpdate": 42, # If this is greater than zero, then this is the number of days after a pending update becoming available that a device can remain compliant, without taking the update. Has no effect otherwise. "endMinutes": 42, # If the type is WINDOWED, the end of the maintenance window, measured as the number of minutes after midnight in device's local time. This value must be between 0 and 1439, inclusive. If this value is less than start_minutes, then the maintenance window spans midnight. If the maintenance window specified is smaller than 30 minutes, the actual window is extended to 30 minutes beyond the start time. "freezePeriods": [ # An annually repeating time period in which over-the-air (OTA) system updates are postponed to freeze the OS version running on a device. To prevent freezing the device indefinitely, each freeze period must be separated by at least 60 days. { # A system freeze period. When a device’s clock is within the freeze period, all incoming system updates (including security patches) are blocked and won’t be installed.When the device is outside any set freeze periods, the normal policy behavior (automatic, windowed, or postponed) applies.Leap years are ignored in freeze period calculations, in particular: If Feb. 29th is set as the start or end date of a freeze period, the freeze period will start or end on Feb. 28th instead. When a device’s system clock reads Feb. 29th, it’s treated as Feb. 28th. When calculating the number of days in a freeze period or the time between two freeze periods, Feb. 29th is ignored and not counted as a day.Note: For Freeze Periods to take effect, SystemUpdateType cannot be specified as SYSTEM_UPDATE_TYPE_UNSPECIFIED, because freeze periods require a defined policy to be specified. @@ -1999,7 +1996,7 @@

Method Details

], }, "privateDnsSettings": { # Controls the device's private DNS settings. # Optional. The global private DNS settings. - "privateDnsHost": "A String", # Optional. The hostname of the DNS server. This must be set if and only if private_dns_mode is set to PRIVATE_DNS_SPECIFIED_HOST. Supported on Android 10 and above on fully managed devices. A NonComplianceDetail with MANAGEMENT_MODE is reported on other management modes. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 10. A NonComplianceDetail with PENDING is reported if the device is not connected to a network. A NonComplianceDetail with nonComplianceReason INVALID_VALUE and specificNonComplianceReason PRIVATE_DNS_HOST_NOT_SERVING is reported if the specified host is not a DNS server or not supported on Android. A NonComplianceReason with nonComplianceReason INVALID_VALUE is reported if applying this setting fails for any other reason. + "privateDnsHost": "A String", # Optional. The hostname of the DNS server. This must be set if and only if private_dns_mode is set to PRIVATE_DNS_SPECIFIED_HOST. Supported on Android 10 and above on fully managed devices. A NonComplianceDetail with MANAGEMENT_MODE is reported on other management modes. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 10. A NonComplianceDetail with PENDING is reported if the device is not connected to a network. A NonComplianceDetail with nonComplianceReason INVALID_VALUE and specificNonComplianceReason PRIVATE_DNS_HOST_NOT_SERVING is reported if the specified host is not a DNS server or not supported on Android. A NonComplianceDetail with INVALID_VALUE is reported if applying this setting fails for any other reason. "privateDnsMode": "A String", # Optional. The configuration mode for device's global private DNS settings. If this is set to PRIVATE_DNS_SPECIFIED_HOST, then private_dns_host must be set. }, "tetheringSettings": "A String", # Controls tethering settings. Based on the value set, the user is partially or fully disallowed from using different forms of tethering. @@ -2260,7 +2257,6 @@

Method Details

"A String", ], "systemUpdate": { # Configuration for managing system updatesNote: Google Play system updates (https://source.android.com/docs/core/ota/modular-system) (also called Mainline updates) are automatically downloaded but require a device reboot to be installed. Refer to the mainline section in Manage system updates (https://developer.android.com/work/dpc/system-updates#mainline) for further details. # The system update policy, which controls how OS updates are applied. If the update type is WINDOWED, the update window will automatically apply to Play app updates as well.Note: Google Play system updates (https://source.android.com/docs/core/ota/modular-system) (also called Mainline updates) are automatically downloaded and require a device reboot to be installed. Refer to the mainline section in Manage system updates (https://developer.android.com/work/dpc/system-updates#mainline) for further details. - "allowedDaysWithoutUpdate": 42, # If this is greater than zero, then this is the number of days after a pending update becoming available that a device can remain compliant, without taking the update. Has no effect otherwise. "endMinutes": 42, # If the type is WINDOWED, the end of the maintenance window, measured as the number of minutes after midnight in device's local time. This value must be between 0 and 1439, inclusive. If this value is less than start_minutes, then the maintenance window spans midnight. If the maintenance window specified is smaller than 30 minutes, the actual window is extended to 30 minutes beyond the start time. "freezePeriods": [ # An annually repeating time period in which over-the-air (OTA) system updates are postponed to freeze the OS version running on a device. To prevent freezing the device indefinitely, each freeze period must be separated by at least 60 days. { # A system freeze period. When a device’s clock is within the freeze period, all incoming system updates (including security patches) are blocked and won’t be installed.When the device is outside any set freeze periods, the normal policy behavior (automatic, windowed, or postponed) applies.Leap years are ignored in freeze period calculations, in particular: If Feb. 29th is set as the start or end date of a freeze period, the freeze period will start or end on Feb. 28th instead. When a device’s system clock reads Feb. 29th, it’s treated as Feb. 28th. When calculating the number of days in a freeze period or the time between two freeze periods, Feb. 29th is ignored and not counted as a day.Note: For Freeze Periods to take effect, SystemUpdateType cannot be specified as SYSTEM_UPDATE_TYPE_UNSPECIFIED, because freeze periods require a defined policy to be specified. @@ -2516,7 +2512,7 @@

Method Details

], }, "privateDnsSettings": { # Controls the device's private DNS settings. # Optional. The global private DNS settings. - "privateDnsHost": "A String", # Optional. The hostname of the DNS server. This must be set if and only if private_dns_mode is set to PRIVATE_DNS_SPECIFIED_HOST. Supported on Android 10 and above on fully managed devices. A NonComplianceDetail with MANAGEMENT_MODE is reported on other management modes. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 10. A NonComplianceDetail with PENDING is reported if the device is not connected to a network. A NonComplianceDetail with nonComplianceReason INVALID_VALUE and specificNonComplianceReason PRIVATE_DNS_HOST_NOT_SERVING is reported if the specified host is not a DNS server or not supported on Android. A NonComplianceReason with nonComplianceReason INVALID_VALUE is reported if applying this setting fails for any other reason. + "privateDnsHost": "A String", # Optional. The hostname of the DNS server. This must be set if and only if private_dns_mode is set to PRIVATE_DNS_SPECIFIED_HOST. Supported on Android 10 and above on fully managed devices. A NonComplianceDetail with MANAGEMENT_MODE is reported on other management modes. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 10. A NonComplianceDetail with PENDING is reported if the device is not connected to a network. A NonComplianceDetail with nonComplianceReason INVALID_VALUE and specificNonComplianceReason PRIVATE_DNS_HOST_NOT_SERVING is reported if the specified host is not a DNS server or not supported on Android. A NonComplianceDetail with INVALID_VALUE is reported if applying this setting fails for any other reason. "privateDnsMode": "A String", # Optional. The configuration mode for device's global private DNS settings. If this is set to PRIVATE_DNS_SPECIFIED_HOST, then private_dns_host must be set. }, "tetheringSettings": "A String", # Controls tethering settings. Based on the value set, the user is partially or fully disallowed from using different forms of tethering. @@ -2777,7 +2773,6 @@

Method Details

"A String", ], "systemUpdate": { # Configuration for managing system updatesNote: Google Play system updates (https://source.android.com/docs/core/ota/modular-system) (also called Mainline updates) are automatically downloaded but require a device reboot to be installed. Refer to the mainline section in Manage system updates (https://developer.android.com/work/dpc/system-updates#mainline) for further details. # The system update policy, which controls how OS updates are applied. If the update type is WINDOWED, the update window will automatically apply to Play app updates as well.Note: Google Play system updates (https://source.android.com/docs/core/ota/modular-system) (also called Mainline updates) are automatically downloaded and require a device reboot to be installed. Refer to the mainline section in Manage system updates (https://developer.android.com/work/dpc/system-updates#mainline) for further details. - "allowedDaysWithoutUpdate": 42, # If this is greater than zero, then this is the number of days after a pending update becoming available that a device can remain compliant, without taking the update. Has no effect otherwise. "endMinutes": 42, # If the type is WINDOWED, the end of the maintenance window, measured as the number of minutes after midnight in device's local time. This value must be between 0 and 1439, inclusive. If this value is less than start_minutes, then the maintenance window spans midnight. If the maintenance window specified is smaller than 30 minutes, the actual window is extended to 30 minutes beyond the start time. "freezePeriods": [ # An annually repeating time period in which over-the-air (OTA) system updates are postponed to freeze the OS version running on a device. To prevent freezing the device indefinitely, each freeze period must be separated by at least 60 days. { # A system freeze period. When a device’s clock is within the freeze period, all incoming system updates (including security patches) are blocked and won’t be installed.When the device is outside any set freeze periods, the normal policy behavior (automatic, windowed, or postponed) applies.Leap years are ignored in freeze period calculations, in particular: If Feb. 29th is set as the start or end date of a freeze period, the freeze period will start or end on Feb. 28th instead. When a device’s system clock reads Feb. 29th, it’s treated as Feb. 28th. When calculating the number of days in a freeze period or the time between two freeze periods, Feb. 29th is ignored and not counted as a day.Note: For Freeze Periods to take effect, SystemUpdateType cannot be specified as SYSTEM_UPDATE_TYPE_UNSPECIFIED, because freeze periods require a defined policy to be specified. @@ -3049,7 +3044,7 @@

Method Details

], }, "privateDnsSettings": { # Controls the device's private DNS settings. # Optional. The global private DNS settings. - "privateDnsHost": "A String", # Optional. The hostname of the DNS server. This must be set if and only if private_dns_mode is set to PRIVATE_DNS_SPECIFIED_HOST. Supported on Android 10 and above on fully managed devices. A NonComplianceDetail with MANAGEMENT_MODE is reported on other management modes. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 10. A NonComplianceDetail with PENDING is reported if the device is not connected to a network. A NonComplianceDetail with nonComplianceReason INVALID_VALUE and specificNonComplianceReason PRIVATE_DNS_HOST_NOT_SERVING is reported if the specified host is not a DNS server or not supported on Android. A NonComplianceReason with nonComplianceReason INVALID_VALUE is reported if applying this setting fails for any other reason. + "privateDnsHost": "A String", # Optional. The hostname of the DNS server. This must be set if and only if private_dns_mode is set to PRIVATE_DNS_SPECIFIED_HOST. Supported on Android 10 and above on fully managed devices. A NonComplianceDetail with MANAGEMENT_MODE is reported on other management modes. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 10. A NonComplianceDetail with PENDING is reported if the device is not connected to a network. A NonComplianceDetail with nonComplianceReason INVALID_VALUE and specificNonComplianceReason PRIVATE_DNS_HOST_NOT_SERVING is reported if the specified host is not a DNS server or not supported on Android. A NonComplianceDetail with INVALID_VALUE is reported if applying this setting fails for any other reason. "privateDnsMode": "A String", # Optional. The configuration mode for device's global private DNS settings. If this is set to PRIVATE_DNS_SPECIFIED_HOST, then private_dns_host must be set. }, "tetheringSettings": "A String", # Controls tethering settings. Based on the value set, the user is partially or fully disallowed from using different forms of tethering. @@ -3310,7 +3305,6 @@

Method Details

"A String", ], "systemUpdate": { # Configuration for managing system updatesNote: Google Play system updates (https://source.android.com/docs/core/ota/modular-system) (also called Mainline updates) are automatically downloaded but require a device reboot to be installed. Refer to the mainline section in Manage system updates (https://developer.android.com/work/dpc/system-updates#mainline) for further details. # The system update policy, which controls how OS updates are applied. If the update type is WINDOWED, the update window will automatically apply to Play app updates as well.Note: Google Play system updates (https://source.android.com/docs/core/ota/modular-system) (also called Mainline updates) are automatically downloaded and require a device reboot to be installed. Refer to the mainline section in Manage system updates (https://developer.android.com/work/dpc/system-updates#mainline) for further details. - "allowedDaysWithoutUpdate": 42, # If this is greater than zero, then this is the number of days after a pending update becoming available that a device can remain compliant, without taking the update. Has no effect otherwise. "endMinutes": 42, # If the type is WINDOWED, the end of the maintenance window, measured as the number of minutes after midnight in device's local time. This value must be between 0 and 1439, inclusive. If this value is less than start_minutes, then the maintenance window spans midnight. If the maintenance window specified is smaller than 30 minutes, the actual window is extended to 30 minutes beyond the start time. "freezePeriods": [ # An annually repeating time period in which over-the-air (OTA) system updates are postponed to freeze the OS version running on a device. To prevent freezing the device indefinitely, each freeze period must be separated by at least 60 days. { # A system freeze period. When a device’s clock is within the freeze period, all incoming system updates (including security patches) are blocked and won’t be installed.When the device is outside any set freeze periods, the normal policy behavior (automatic, windowed, or postponed) applies.Leap years are ignored in freeze period calculations, in particular: If Feb. 29th is set as the start or end date of a freeze period, the freeze period will start or end on Feb. 28th instead. When a device’s system clock reads Feb. 29th, it’s treated as Feb. 28th. When calculating the number of days in a freeze period or the time between two freeze periods, Feb. 29th is ignored and not counted as a day.Note: For Freeze Periods to take effect, SystemUpdateType cannot be specified as SYSTEM_UPDATE_TYPE_UNSPECIFIED, because freeze periods require a defined policy to be specified. diff --git a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json index bfa3824f11..5724a1fd75 100644 --- a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json @@ -1265,7 +1265,7 @@ } } }, -"revision": "20260225", +"revision": "20260303", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdbShellCommandEvent": { @@ -6890,7 +6890,7 @@ false "id": "PrivateDnsSettings", "properties": { "privateDnsHost": { -"description": "Optional. The hostname of the DNS server. This must be set if and only if private_dns_mode is set to PRIVATE_DNS_SPECIFIED_HOST. Supported on Android 10 and above on fully managed devices. A NonComplianceDetail with MANAGEMENT_MODE is reported on other management modes. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 10. A NonComplianceDetail with PENDING is reported if the device is not connected to a network. A NonComplianceDetail with nonComplianceReason INVALID_VALUE and specificNonComplianceReason PRIVATE_DNS_HOST_NOT_SERVING is reported if the specified host is not a DNS server or not supported on Android. A NonComplianceReason with nonComplianceReason INVALID_VALUE is reported if applying this setting fails for any other reason.", +"description": "Optional. The hostname of the DNS server. This must be set if and only if private_dns_mode is set to PRIVATE_DNS_SPECIFIED_HOST. Supported on Android 10 and above on fully managed devices. A NonComplianceDetail with MANAGEMENT_MODE is reported on other management modes. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 10. A NonComplianceDetail with PENDING is reported if the device is not connected to a network. A NonComplianceDetail with nonComplianceReason INVALID_VALUE and specificNonComplianceReason PRIVATE_DNS_HOST_NOT_SERVING is reported if the specified host is not a DNS server or not supported on Android. A NonComplianceDetail with INVALID_VALUE is reported if applying this setting fails for any other reason.", "type": "string" }, "privateDnsMode": { @@ -6904,7 +6904,7 @@ false "enumDescriptions": [ "Unspecified. Defaults to PRIVATE_DNS_USER_CHOICE.", "The user is allowed to configure private DNS.", -"Automatic private DNS mode. The device tries to use the network-provided DNS server over an encrypted connection before resorting to cleartext. The user is not allowed to modify this setting. Supported on Android 10 and above on fully managed devices and work profiles on company-owned devices. A NonComplianceDetail with MANAGEMENT_MODE is reported on other management modes. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 10. A NonComplianceReason with INVALID_VALUE is reported if setting this fails for any other reason.Note: For work profiles on company-owned devices, setting this mode prevents the user from changing the setting, but the active private DNS setting is not modified. A NonComplianceDetail with MANAGEMENT_MODE is reported in this case.", +"Automatic private DNS mode. The device tries to use the network-provided DNS server over an encrypted connection before resorting to cleartext. The user is not allowed to modify this setting. Supported on Android 10 and above on fully managed devices and work profiles on company-owned devices. A NonComplianceDetail with MANAGEMENT_MODE is reported on other management modes. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 10. A NonComplianceDetail with INVALID_VALUE is reported if setting this fails for any other reason.Note: For work profiles on company-owned devices, setting this mode prevents the user from changing the setting, but the active private DNS setting is not modified. A NonComplianceDetail with MANAGEMENT_MODE is reported in this case.", "The device only uses the DNS server specified in private_dns_host. The user is not allowed to modify this setting. If this is set, then private_dns_host must be set. Supported on Android 10 and above on fully managed devices. A NonComplianceDetail with MANAGEMENT_MODE is reported on other management modes. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 10." ], "type": "string" @@ -7572,11 +7572,6 @@ false "description": "Configuration for managing system updatesNote: Google Play system updates (https://source.android.com/docs/core/ota/modular-system) (also called Mainline updates) are automatically downloaded but require a device reboot to be installed. Refer to the mainline section in Manage system updates (https://developer.android.com/work/dpc/system-updates#mainline) for further details.", "id": "SystemUpdate", "properties": { -"allowedDaysWithoutUpdate": { -"description": "If this is greater than zero, then this is the number of days after a pending update becoming available that a device can remain compliant, without taking the update. Has no effect otherwise.", -"format": "int32", -"type": "integer" -}, "endMinutes": { "description": "If the type is WINDOWED, the end of the maintenance window, measured as the number of minutes after midnight in device's local time. This value must be between 0 and 1439, inclusive. If this value is less than start_minutes, then the maintenance window spans midnight. If the maintenance window specified is smaller than 30 minutes, the actual window is extended to 30 minutes beyond the start time.", "format": "int32", From bc6831124067abf3c765c1d17a1eef1e40999e2c Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 10 Mar 2026 07:24:03 +0000 Subject: [PATCH 05/31] feat(backupdr): update the api #### backupdr:v1 The following keys were deleted: - schemas.OperationMetadata (Total Keys: 21) The following keys were added: - schemas.GoogleCloudBackupdrV1OperationMetadata (Total Keys: 21) --- .../documents/backupdr.v1.json | 118 ++++++++++-------- 1 file changed, 64 insertions(+), 54 deletions(-) diff --git a/googleapiclient/discovery_cache/documents/backupdr.v1.json b/googleapiclient/discovery_cache/documents/backupdr.v1.json index 9d5a6b349c..929ed80b09 100644 --- a/googleapiclient/discovery_cache/documents/backupdr.v1.json +++ b/googleapiclient/discovery_cache/documents/backupdr.v1.json @@ -2262,7 +2262,7 @@ } } }, -"revision": "20260224", +"revision": "20260227", "rootUrl": "https://backupdr.googleapis.com/", "schemas": { "AbandonBackupRequest": { @@ -5049,6 +5049,58 @@ }, "type": "object" }, +"GoogleCloudBackupdrV1OperationMetadata": { +"description": "Represents the metadata of the long-running operation.", +"id": "GoogleCloudBackupdrV1OperationMetadata", +"properties": { +"additionalInfo": { +"additionalProperties": { +"type": "string" +}, +"description": "Output only. AdditionalInfo contains additional Info related to backup plan association resource.", +"readOnly": true, +"type": "object" +}, +"apiVersion": { +"description": "Output only. API version used to start the operation.", +"readOnly": true, +"type": "string" +}, +"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" +}, +"requestedCancellation": { +"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to 'Code.CANCELLED'.", +"readOnly": true, +"type": "boolean" +}, +"statusMessage": { +"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" +}, "GuestOsFeature": { "description": "Feature type of the Guest OS.", "id": "GuestOsFeature", @@ -5489,12 +5541,22 @@ "FEATURE_UNSPECIFIED", "MANAGEMENT_SERVER", "COMPUTE_INSTANCE", -"PROTECTION_SUMMARY" +"PROTECTION_SUMMARY", +"DISK", +"CLOUD_SQL", +"ALLOY_DB", +"FILESTORE", +"SAAS_PLATFORM" ], "enumDescriptions": [ "", "", "", +"", +"", +"", +"", +"", "" ], "type": "string" @@ -5872,58 +5934,6 @@ }, "type": "object" }, -"OperationMetadata": { -"description": "Represents the metadata of the long-running operation.", -"id": "OperationMetadata", -"properties": { -"additionalInfo": { -"additionalProperties": { -"type": "string" -}, -"description": "Output only. AdditionalInfo contains additional Info related to backup plan association resource.", -"readOnly": true, -"type": "object" -}, -"apiVersion": { -"description": "Output only. API version used to start the operation.", -"readOnly": true, -"type": "string" -}, -"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" -}, -"requestedCancellation": { -"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to 'Code.CANCELLED'.", -"readOnly": true, -"type": "boolean" -}, -"statusMessage": { -"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" -}, "PitrSettings": { "description": "Point in time recovery settings of the backup configuration resource.", "id": "PitrSettings", From d4731d803581e75f1e83427a566487ead2ee432a Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 10 Mar 2026 07:24:03 +0000 Subject: [PATCH 06/31] feat(beyondcorp): update the api #### beyondcorp:v1 The following keys were added: - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1LoggingConfig (Total Keys: 2) - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGateway.properties.logging.$ref (Total Keys: 1) #### beyondcorp:v1alpha The following keys were added: - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaLoggingConfig (Total Keys: 2) - schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway.properties.logging.$ref (Total Keys: 1) --- ...v1.projects.locations.securityGateways.html | 8 ++++++++ ...ha.projects.locations.securityGateways.html | 8 ++++++++ .../documents/beyondcorp.v1.json | 12 +++++++++++- .../documents/beyondcorp.v1alpha.json | 18 +++++++++++++++--- 4 files changed, 42 insertions(+), 4 deletions(-) diff --git a/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.html b/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.html index 9001154421..7f424bcdaa 100644 --- a/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.html +++ b/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.html @@ -140,6 +140,8 @@

Method Details

}, }, }, + "logging": { # Configuration for Cloud Logging. # Optional. Configuration for Cloud Logging. If this field is present, the logging will be enabled. + }, "name": "A String", # Identifier. Name of the resource. "proxyProtocolConfig": { # The configuration for the proxy. # Optional. Shared proxy configuration for all apps. "allowedClientHeaders": [ # Optional. List of the allowed client header names. @@ -272,6 +274,8 @@

Method Details

}, }, }, + "logging": { # Configuration for Cloud Logging. # Optional. Configuration for Cloud Logging. If this field is present, the logging will be enabled. + }, "name": "A String", # Identifier. Name of the resource. "proxyProtocolConfig": { # The configuration for the proxy. # Optional. Shared proxy configuration for all apps. "allowedClientHeaders": [ # Optional. List of the allowed client header names. @@ -392,6 +396,8 @@

Method Details

}, }, }, + "logging": { # Configuration for Cloud Logging. # Optional. Configuration for Cloud Logging. If this field is present, the logging will be enabled. + }, "name": "A String", # Identifier. Name of the resource. "proxyProtocolConfig": { # The configuration for the proxy. # Optional. Shared proxy configuration for all apps. "allowedClientHeaders": [ # Optional. List of the allowed client header names. @@ -471,6 +477,8 @@

Method Details

}, }, }, + "logging": { # Configuration for Cloud Logging. # Optional. Configuration for Cloud Logging. If this field is present, the logging will be enabled. + }, "name": "A String", # Identifier. Name of the resource. "proxyProtocolConfig": { # The configuration for the proxy. # Optional. Shared proxy configuration for all apps. "allowedClientHeaders": [ # Optional. List of the allowed client header names. diff --git a/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.html b/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.html index 182bea6c26..4cd1aea3d2 100644 --- a/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.html +++ b/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.html @@ -140,6 +140,8 @@

Method Details

}, }, }, + "logging": { # Configuration for Cloud Logging. # Optional. Configuration for Cloud Logging. If this field is present, the logging will be enabled. + }, "name": "A String", # Identifier. Name of the resource. "proxyProtocolConfig": { # The configuration for the proxy. # Optional. Shared proxy configuration for all apps. "allowedClientHeaders": [ # Optional. List of the allowed client header names. @@ -272,6 +274,8 @@

Method Details

}, }, }, + "logging": { # Configuration for Cloud Logging. # Optional. Configuration for Cloud Logging. If this field is present, the logging will be enabled. + }, "name": "A String", # Identifier. Name of the resource. "proxyProtocolConfig": { # The configuration for the proxy. # Optional. Shared proxy configuration for all apps. "allowedClientHeaders": [ # Optional. List of the allowed client header names. @@ -392,6 +396,8 @@

Method Details

}, }, }, + "logging": { # Configuration for Cloud Logging. # Optional. Configuration for Cloud Logging. If this field is present, the logging will be enabled. + }, "name": "A String", # Identifier. Name of the resource. "proxyProtocolConfig": { # The configuration for the proxy. # Optional. Shared proxy configuration for all apps. "allowedClientHeaders": [ # Optional. List of the allowed client header names. @@ -471,6 +477,8 @@

Method Details

}, }, }, + "logging": { # Configuration for Cloud Logging. # Optional. Configuration for Cloud Logging. If this field is present, the logging will be enabled. + }, "name": "A String", # Identifier. Name of the resource. "proxyProtocolConfig": { # The configuration for the proxy. # Optional. Shared proxy configuration for all apps. "allowedClientHeaders": [ # Optional. List of the allowed client header names. diff --git a/googleapiclient/discovery_cache/documents/beyondcorp.v1.json b/googleapiclient/discovery_cache/documents/beyondcorp.v1.json index 11c23b409d..7ff006e3b9 100644 --- a/googleapiclient/discovery_cache/documents/beyondcorp.v1.json +++ b/googleapiclient/discovery_cache/documents/beyondcorp.v1.json @@ -1909,7 +1909,7 @@ } } }, -"revision": "20260128", +"revision": "20260228", "rootUrl": "https://beyondcorp.googleapis.com/", "schemas": { "AllocatedConnection": { @@ -3474,6 +3474,12 @@ }, "type": "object" }, +"GoogleCloudBeyondcorpSecuritygatewaysV1LoggingConfig": { +"description": "Configuration for Cloud Logging.", +"id": "GoogleCloudBeyondcorpSecuritygatewaysV1LoggingConfig", +"properties": {}, +"type": "object" +}, "GoogleCloudBeyondcorpSecuritygatewaysV1ProxyProtocolConfig": { "description": "The configuration for the proxy.", "id": "GoogleCloudBeyondcorpSecuritygatewaysV1ProxyProtocolConfig", @@ -3549,6 +3555,10 @@ "description": "Optional. Map of Hubs that represents regional data path deployment with GCP region as a key.", "type": "object" }, +"logging": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1LoggingConfig", +"description": "Optional. Configuration for Cloud Logging. If this field is present, the logging will be enabled." +}, "name": { "description": "Identifier. Name of the resource.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json b/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json index e88e2509d4..7a37d9eab5 100644 --- a/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json @@ -3332,7 +3332,7 @@ } } }, -"revision": "20260128", +"revision": "20260228", "rootUrl": "https://beyondcorp.googleapis.com/", "schemas": { "AllocatedConnection": { @@ -5223,12 +5223,14 @@ "enum": [ "SUBSCRIBER_TYPE_UNSPECIFIED", "ONLINE", -"OFFLINE" +"OFFLINE", +"CEP_TRIAL" ], "enumDescriptions": [ "Default value. This value is unused.", "Represents an online subscription.", -"Represents an offline subscription." +"Represents an offline subscription.", +"Represents a trial subscription. This maps to the 'TRIAL' subscriber_type in the Entitler proto (google3/identity/cloud/contextawareaccess/billing/proto/enums.proto), but is named 'CEP_TRIAL' here to avoid a name collision with the 'Type' enum defined above." ], "readOnly": true, "type": "string" @@ -5628,6 +5630,12 @@ }, "type": "object" }, +"GoogleCloudBeyondcorpSecuritygatewaysV1alphaLoggingConfig": { +"description": "Configuration for Cloud Logging.", +"id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaLoggingConfig", +"properties": {}, +"type": "object" +}, "GoogleCloudBeyondcorpSecuritygatewaysV1alphaProxyProtocolConfig": { "description": "The configuration for the proxy.", "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaProxyProtocolConfig", @@ -5703,6 +5711,10 @@ "description": "Optional. Map of Hubs that represents regional data path deployment with GCP region as a key.", "type": "object" }, +"logging": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaLoggingConfig", +"description": "Optional. Configuration for Cloud Logging. If this field is present, the logging will be enabled." +}, "name": { "description": "Identifier. Name of the resource.", "type": "string" From 8854dfe2d738d0aa03fb5c2827ebc2371a5b5af8 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 10 Mar 2026 07:24:03 +0000 Subject: [PATCH 07/31] feat(calendar): update the api #### calendar:v3 The following keys were added: - schemas.EventLabel (Total Keys: 2) - schemas.LabelProperties (Total Keys: 2) --- .../discovery_cache/documents/calendar.v3.json | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/googleapiclient/discovery_cache/documents/calendar.v3.json b/googleapiclient/discovery_cache/documents/calendar.v3.json index 3287fba78b..38ce5d4475 100644 --- a/googleapiclient/discovery_cache/documents/calendar.v3.json +++ b/googleapiclient/discovery_cache/documents/calendar.v3.json @@ -1890,7 +1890,7 @@ } } }, -"revision": "20260215", +"revision": "20260225", "rootUrl": "https://www.googleapis.com/", "schemas": { "Acl": { @@ -2948,6 +2948,10 @@ }, "type": "object" }, +"EventLabel": { +"id": "EventLabel", +"type": "object" +}, "EventOutOfOfficeProperties": { "id": "EventOutOfOfficeProperties", "properties": { @@ -3210,6 +3214,10 @@ }, "type": "object" }, +"LabelProperties": { +"id": "LabelProperties", +"type": "object" +}, "Setting": { "id": "Setting", "properties": { From 782936c6baae3d3c5288079e11503f851c4634f3 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 10 Mar 2026 07:24:03 +0000 Subject: [PATCH 08/31] feat(ces): update the api #### ces:v1 The following keys were added: - schemas.App.properties.errorHandlingSettings.$ref (Total Keys: 1) - schemas.Chunk.properties.blob.$ref (Total Keys: 1) - schemas.EndpointControlPolicy (Total Keys: 5) - schemas.ErrorHandlingSettings (Total Keys: 3) - schemas.SecuritySettings (Total Keys: 10) - schemas.SessionConfig.properties.useToolFakes.type (Total Keys: 1) #### ces:v1beta The following keys were added: - resources.projects.resources.locations.methods.getSecuritySettings (Total Keys: 11) - resources.projects.resources.locations.methods.updateSecuritySettings (Total Keys: 15) - resources.projects.resources.locations.resources.apps.resources.evaluations.methods.uploadEvaluationAudio (Total Keys: 12) - schemas.App.properties.errorHandlingSettings.$ref (Total Keys: 1) - schemas.Chunk.properties.blob.$ref (Total Keys: 1) - schemas.EndpointControlPolicy (Total Keys: 5) - schemas.ErrorHandlingSettings (Total Keys: 3) - schemas.SecuritySettings (Total Keys: 10) - schemas.SessionConfig.properties.useToolFakes.type (Total Keys: 1) - schemas.UploadEvaluationAudioRequest (Total Keys: 5) - schemas.UploadEvaluationAudioResponse (Total Keys: 6) --- ...projects.locations.apps.conversations.html | 16 ++ ...1.projects.locations.apps.deployments.html | 26 +- ...s_v1.projects.locations.apps.examples.html | 24 ++ docs/dyn/ces_v1.projects.locations.apps.html | 15 + ...s_v1.projects.locations.apps.sessions.html | 11 +- .../ces_v1.projects.locations.apps.tools.html | 38 +-- ...s_v1.projects.locations.apps.toolsets.html | 30 +- ...s_v1.projects.locations.apps.versions.html | 68 +++-- ...projects.locations.apps.conversations.html | 16 ++ ...a.projects.locations.apps.deployments.html | 26 +- ...a.projects.locations.apps.evaluations.html | 272 ++++++++++++++++++ ...ts.locations.apps.evaluations.results.html | 32 +++ ...beta.projects.locations.apps.examples.html | 24 ++ .../ces_v1beta.projects.locations.apps.html | 15 + ...beta.projects.locations.apps.sessions.html | 11 +- ..._v1beta.projects.locations.apps.tools.html | 38 +-- ...beta.projects.locations.apps.toolsets.html | 30 +- ...beta.projects.locations.apps.versions.html | 68 +++-- docs/dyn/ces_v1beta.projects.locations.html | 79 +++++ .../discovery_cache/documents/ces.v1.json | 109 ++++++- .../discovery_cache/documents/ces.v1beta.json | 235 ++++++++++++++- 21 files changed, 1031 insertions(+), 152 deletions(-) diff --git a/docs/dyn/ces_v1.projects.locations.apps.conversations.html b/docs/dyn/ces_v1.projects.locations.apps.conversations.html index baf5ebc373..36b71b53af 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.conversations.html +++ b/docs/dyn/ces_v1.projects.locations.apps.conversations.html @@ -204,6 +204,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -263,6 +267,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -374,6 +382,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -433,6 +445,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, diff --git a/docs/dyn/ces_v1.projects.locations.apps.deployments.html b/docs/dyn/ces_v1.projects.locations.apps.deployments.html index 523e02f9ac..485c6cadf3 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.deployments.html +++ b/docs/dyn/ces_v1.projects.locations.apps.deployments.html @@ -111,7 +111,7 @@

Method Details

The object takes the form of: { # A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile. - "appVersion": "A String", # Required. The resource name of the app version to deploy. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version} + "appVersion": "A String", # Optional. The resource name of the app version to deploy. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` Use `projects/{project}/locations/{location}/apps/{app}/versions/-` to use the draft app. "channelProfile": { # A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. # Required. The channel profile used in the deployment. "channelType": "A String", # Optional. The type of the channel profile. "disableBargeInControl": True or False, # Optional. Whether to disable user barge-in control in the conversation. - **true**: User interruptions are disabled while the agent is speaking. - **false**: The agent retains automatic control over when the user can interrupt. @@ -138,7 +138,7 @@

Method Details

"createTime": "A String", # Output only. Timestamp when this deployment was created. "displayName": "A String", # Required. Display name of the deployment. "etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. - "name": "A String", # Identifier. The resource name of the deployment. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment} + "name": "A String", # Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` "updateTime": "A String", # Output only. Timestamp when this deployment was last updated. } @@ -152,7 +152,7 @@

Method Details

An object of the form: { # A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile. - "appVersion": "A String", # Required. The resource name of the app version to deploy. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version} + "appVersion": "A String", # Optional. The resource name of the app version to deploy. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` Use `projects/{project}/locations/{location}/apps/{app}/versions/-` to use the draft app. "channelProfile": { # A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. # Required. The channel profile used in the deployment. "channelType": "A String", # Optional. The type of the channel profile. "disableBargeInControl": True or False, # Optional. Whether to disable user barge-in control in the conversation. - **true**: User interruptions are disabled while the agent is speaking. - **false**: The agent retains automatic control over when the user can interrupt. @@ -179,7 +179,7 @@

Method Details

"createTime": "A String", # Output only. Timestamp when this deployment was created. "displayName": "A String", # Required. Display name of the deployment. "etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. - "name": "A String", # Identifier. The resource name of the deployment. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment} + "name": "A String", # Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` "updateTime": "A String", # Output only. Timestamp when this deployment was last updated. }
@@ -218,7 +218,7 @@

Method Details

An object of the form: { # A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile. - "appVersion": "A String", # Required. The resource name of the app version to deploy. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version} + "appVersion": "A String", # Optional. The resource name of the app version to deploy. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` Use `projects/{project}/locations/{location}/apps/{app}/versions/-` to use the draft app. "channelProfile": { # A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. # Required. The channel profile used in the deployment. "channelType": "A String", # Optional. The type of the channel profile. "disableBargeInControl": True or False, # Optional. Whether to disable user barge-in control in the conversation. - **true**: User interruptions are disabled while the agent is speaking. - **false**: The agent retains automatic control over when the user can interrupt. @@ -245,7 +245,7 @@

Method Details

"createTime": "A String", # Output only. Timestamp when this deployment was created. "displayName": "A String", # Required. Display name of the deployment. "etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. - "name": "A String", # Identifier. The resource name of the deployment. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment} + "name": "A String", # Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` "updateTime": "A String", # Output only. Timestamp when this deployment was last updated. } @@ -270,7 +270,7 @@

Method Details

{ # Response message for AgentService.ListDeployments. "deployments": [ # The list of deployments. { # A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile. - "appVersion": "A String", # Required. The resource name of the app version to deploy. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version} + "appVersion": "A String", # Optional. The resource name of the app version to deploy. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` Use `projects/{project}/locations/{location}/apps/{app}/versions/-` to use the draft app. "channelProfile": { # A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. # Required. The channel profile used in the deployment. "channelType": "A String", # Optional. The type of the channel profile. "disableBargeInControl": True or False, # Optional. Whether to disable user barge-in control in the conversation. - **true**: User interruptions are disabled while the agent is speaking. - **false**: The agent retains automatic control over when the user can interrupt. @@ -297,7 +297,7 @@

Method Details

"createTime": "A String", # Output only. Timestamp when this deployment was created. "displayName": "A String", # Required. Display name of the deployment. "etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. - "name": "A String", # Identifier. The resource name of the deployment. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment} + "name": "A String", # Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` "updateTime": "A String", # Output only. Timestamp when this deployment was last updated. }, ], @@ -324,12 +324,12 @@

Method Details

Updates the specified deployment.
 
 Args:
-  name: string, Identifier. The resource name of the deployment. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment} (required)
+  name: string, Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` (required)
   body: object, The request body.
     The object takes the form of:
 
 { # A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile.
-  "appVersion": "A String", # Required. The resource name of the app version to deploy. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}
+  "appVersion": "A String", # Optional. The resource name of the app version to deploy. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` Use `projects/{project}/locations/{location}/apps/{app}/versions/-` to use the draft app.
   "channelProfile": { # A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. # Required. The channel profile used in the deployment.
     "channelType": "A String", # Optional. The type of the channel profile.
     "disableBargeInControl": True or False, # Optional. Whether to disable user barge-in control in the conversation. - **true**: User interruptions are disabled while the agent is speaking. - **false**: The agent retains automatic control over when the user can interrupt.
@@ -356,7 +356,7 @@ 

Method Details

"createTime": "A String", # Output only. Timestamp when this deployment was created. "displayName": "A String", # Required. Display name of the deployment. "etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. - "name": "A String", # Identifier. The resource name of the deployment. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment} + "name": "A String", # Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` "updateTime": "A String", # Output only. Timestamp when this deployment was last updated. } @@ -370,7 +370,7 @@

Method Details

An object of the form: { # A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile. - "appVersion": "A String", # Required. The resource name of the app version to deploy. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version} + "appVersion": "A String", # Optional. The resource name of the app version to deploy. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` Use `projects/{project}/locations/{location}/apps/{app}/versions/-` to use the draft app. "channelProfile": { # A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. # Required. The channel profile used in the deployment. "channelType": "A String", # Optional. The type of the channel profile. "disableBargeInControl": True or False, # Optional. Whether to disable user barge-in control in the conversation. - **true**: User interruptions are disabled while the agent is speaking. - **false**: The agent retains automatic control over when the user can interrupt. @@ -397,7 +397,7 @@

Method Details

"createTime": "A String", # Output only. Timestamp when this deployment was created. "displayName": "A String", # Required. Display name of the deployment. "etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. - "name": "A String", # Identifier. The resource name of the deployment. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment} + "name": "A String", # Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` "updateTime": "A String", # Output only. Timestamp when this deployment was last updated. }
diff --git a/docs/dyn/ces_v1.projects.locations.apps.examples.html b/docs/dyn/ces_v1.projects.locations.apps.examples.html index 028a5faaba..2bda6cc81c 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.examples.html +++ b/docs/dyn/ces_v1.projects.locations.apps.examples.html @@ -125,6 +125,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -198,6 +202,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -296,6 +304,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -381,6 +393,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -472,6 +488,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -545,6 +565,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, diff --git a/docs/dyn/ces_v1.projects.locations.apps.html b/docs/dyn/ces_v1.projects.locations.apps.html index 361274d53c..1e874a6243 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.html +++ b/docs/dyn/ces_v1.projects.locations.apps.html @@ -232,6 +232,9 @@

Method Details

"deploymentCount": 42, # Output only. Number of deployments in the app. "description": "A String", # Optional. Human-readable description of the app. "displayName": "A String", # Required. Display name of the app. + "errorHandlingSettings": { # Settings to describe how errors should be handled in the app. # Optional. Error handling settings of the app. + "errorHandlingStrategy": "A String", # Optional. The strategy to use for error handling. + }, "etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Optional. The evaluation thresholds for the app. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -617,6 +620,9 @@

Method Details

"deploymentCount": 42, # Output only. Number of deployments in the app. "description": "A String", # Optional. Human-readable description of the app. "displayName": "A String", # Required. Display name of the app. + "errorHandlingSettings": { # Settings to describe how errors should be handled in the app. # Optional. Error handling settings of the app. + "errorHandlingStrategy": "A String", # Optional. The strategy to use for error handling. + }, "etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Optional. The evaluation thresholds for the app. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -903,6 +909,9 @@

Method Details

"deploymentCount": 42, # Output only. Number of deployments in the app. "description": "A String", # Optional. Human-readable description of the app. "displayName": "A String", # Required. Display name of the app. + "errorHandlingSettings": { # Settings to describe how errors should be handled in the app. # Optional. Error handling settings of the app. + "errorHandlingStrategy": "A String", # Optional. The strategy to use for error handling. + }, "etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Optional. The evaluation thresholds for the app. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -1149,6 +1158,9 @@

Method Details

"deploymentCount": 42, # Output only. Number of deployments in the app. "description": "A String", # Optional. Human-readable description of the app. "displayName": "A String", # Required. Display name of the app. + "errorHandlingSettings": { # Settings to describe how errors should be handled in the app. # Optional. Error handling settings of the app. + "errorHandlingStrategy": "A String", # Optional. The strategy to use for error handling. + }, "etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Optional. The evaluation thresholds for the app. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -1374,6 +1386,9 @@

Method Details

"deploymentCount": 42, # Output only. Number of deployments in the app. "description": "A String", # Optional. Human-readable description of the app. "displayName": "A String", # Required. Display name of the app. + "errorHandlingSettings": { # Settings to describe how errors should be handled in the app. # Optional. Error handling settings of the app. + "errorHandlingStrategy": "A String", # Optional. The strategy to use for error handling. + }, "etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Optional. The evaluation thresholds for the app. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. diff --git a/docs/dyn/ces_v1.projects.locations.apps.sessions.html b/docs/dyn/ces_v1.projects.locations.apps.sessions.html index 30b4168dd4..79e2bfd336 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.sessions.html +++ b/docs/dyn/ces_v1.projects.locations.apps.sessions.html @@ -129,7 +129,7 @@

Method Details

{ # Request message for SessionService.RunSession. "config": { # The configuration for the session. # Required. The configuration for the session. "deployment": "A String", # Optional. The deployment of the app to use for the session. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` - "entryAgent": "A String", # Optional. The entry agent to handle the session. If not specified, the session will be handled by the root agent of the app. Format: `projects/{project}/locations/{location}/agents/{agent}` + "entryAgent": "A String", # Optional. The entry agent to handle the session. If not specified, the session will be handled by the root agent of the app. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` "historicalContexts": [ # Optional. The historical context of the session, including user inputs, agent responses, and other messages. Typically, CES agent would manage session automatically so client doesn't need to explicitly populate this field. However, client can optionally override the historical contexts to force the session start from certain state. { # A message within a conversation. "chunks": [ # Optional. Content of the message as a series of chunks. @@ -138,6 +138,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -204,6 +208,7 @@

Method Details

}, }, "timeZone": "A String", # Optional. The time zone of the user. If provided, the agent will use the time zone for date and time related variables. Otherwise, the agent will use the time zone specified in the App.time_zone_settings. The format is the IANA Time Zone Database time zone, e.g. "America/Los_Angeles". + "useToolFakes": True or False, # Optional. Whether to use tool fakes for the session. If this field is set, the agent will attempt use tool fakes instead of calling the real tools. }, "inputs": [ # Required. Inputs for the session. { # Input for the session. @@ -275,6 +280,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, diff --git a/docs/dyn/ces_v1.projects.locations.apps.tools.html b/docs/dyn/ces_v1.projects.locations.apps.tools.html index c7281a1666..993a60d7c7 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.tools.html +++ b/docs/dyn/ces_v1.projects.locations.apps.tools.html @@ -434,13 +434,13 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], }, }, - "name": "A String", # Identifier. The unique identifier of the tool. Format: - `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for ## standalone tools. `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only, they cannot be referenced directly where a tool is expected. + "name": "A String", # Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected. "openApiTool": { # A remote API tool defined by an OpenAPI schema. # Optional. The open API tool. "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required by the API. "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth. @@ -479,7 +479,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client will trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -875,13 +875,13 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], }, }, - "name": "A String", # Identifier. The unique identifier of the tool. Format: - `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for ## standalone tools. `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only, they cannot be referenced directly where a tool is expected. + "name": "A String", # Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected. "openApiTool": { # A remote API tool defined by an OpenAPI schema. # Optional. The open API tool. "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required by the API. "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth. @@ -920,7 +920,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client will trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -1342,13 +1342,13 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], }, }, - "name": "A String", # Identifier. The unique identifier of the tool. Format: - `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for ## standalone tools. `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only, they cannot be referenced directly where a tool is expected. + "name": "A String", # Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected. "openApiTool": { # A remote API tool defined by an OpenAPI schema. # Optional. The open API tool. "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required by the API. "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth. @@ -1387,7 +1387,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client will trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -1796,13 +1796,13 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], }, }, - "name": "A String", # Identifier. The unique identifier of the tool. Format: - `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for ## standalone tools. `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only, they cannot be referenced directly where a tool is expected. + "name": "A String", # Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected. "openApiTool": { # A remote API tool defined by an OpenAPI schema. # Optional. The open API tool. "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required by the API. "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth. @@ -1841,7 +1841,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client will trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -1926,7 +1926,7 @@

Method Details

Updates the specified tool.
 
 Args:
-  name: string, Identifier. The unique identifier of the tool. Format: - `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for ## standalone tools. `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only, they cannot be referenced directly where a tool is expected. (required)
+  name: string, Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -2254,13 +2254,13 @@ 

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], }, }, - "name": "A String", # Identifier. The unique identifier of the tool. Format: - `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for ## standalone tools. `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only, they cannot be referenced directly where a tool is expected. + "name": "A String", # Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected. "openApiTool": { # A remote API tool defined by an OpenAPI schema. # Optional. The open API tool. "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required by the API. "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth. @@ -2299,7 +2299,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client will trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -2695,13 +2695,13 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], }, }, - "name": "A String", # Identifier. The unique identifier of the tool. Format: - `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for ## standalone tools. `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only, they cannot be referenced directly where a tool is expected. + "name": "A String", # Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected. "openApiTool": { # A remote API tool defined by an OpenAPI schema. # Optional. The open API tool. "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required by the API. "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth. @@ -2740,7 +2740,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client will trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], diff --git a/docs/dyn/ces_v1.projects.locations.apps.toolsets.html b/docs/dyn/ces_v1.projects.locations.apps.toolsets.html index cb27a20aa3..b74e5e9660 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.toolsets.html +++ b/docs/dyn/ces_v1.projects.locations.apps.toolsets.html @@ -182,7 +182,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -225,7 +225,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -319,7 +319,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -362,7 +362,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -482,7 +482,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -525,7 +525,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -632,7 +632,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -675,7 +675,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -786,7 +786,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -829,7 +829,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -923,7 +923,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -966,7 +966,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -1332,13 +1332,13 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], }, }, - "name": "A String", # Identifier. The unique identifier of the tool. Format: - `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for ## standalone tools. `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only, they cannot be referenced directly where a tool is expected. + "name": "A String", # Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected. "openApiTool": { # A remote API tool defined by an OpenAPI schema. # Optional. The open API tool. "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required by the API. "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth. @@ -1377,7 +1377,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client will trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], diff --git a/docs/dyn/ces_v1.projects.locations.apps.versions.html b/docs/dyn/ces_v1.projects.locations.apps.versions.html index 257b6cea09..663228565f 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.versions.html +++ b/docs/dyn/ces_v1.projects.locations.apps.versions.html @@ -292,6 +292,9 @@

Method Details

"deploymentCount": 42, # Output only. Number of deployments in the app. "description": "A String", # Optional. Human-readable description of the app. "displayName": "A String", # Required. Display name of the app. + "errorHandlingSettings": { # Settings to describe how errors should be handled in the app. # Optional. Error handling settings of the app. + "errorHandlingStrategy": "A String", # Optional. The strategy to use for error handling. + }, "etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Optional. The evaluation thresholds for the app. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -463,6 +466,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -939,13 +946,13 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], }, }, - "name": "A String", # Identifier. The unique identifier of the tool. Format: - `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for ## standalone tools. `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only, they cannot be referenced directly where a tool is expected. + "name": "A String", # Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected. "openApiTool": { # A remote API tool defined by an OpenAPI schema. # Optional. The open API tool. "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required by the API. "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth. @@ -984,7 +991,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client will trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -1117,7 +1124,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -1160,7 +1167,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -1370,6 +1377,9 @@

Method Details

"deploymentCount": 42, # Output only. Number of deployments in the app. "description": "A String", # Optional. Human-readable description of the app. "displayName": "A String", # Required. Display name of the app. + "errorHandlingSettings": { # Settings to describe how errors should be handled in the app. # Optional. Error handling settings of the app. + "errorHandlingStrategy": "A String", # Optional. The strategy to use for error handling. + }, "etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Optional. The evaluation thresholds for the app. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -1541,6 +1551,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -2017,13 +2031,13 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], }, }, - "name": "A String", # Identifier. The unique identifier of the tool. Format: - `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for ## standalone tools. `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only, they cannot be referenced directly where a tool is expected. + "name": "A String", # Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected. "openApiTool": { # A remote API tool defined by an OpenAPI schema. # Optional. The open API tool. "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required by the API. "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth. @@ -2062,7 +2076,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client will trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -2195,7 +2209,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -2238,7 +2252,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -2473,6 +2487,9 @@

Method Details

"deploymentCount": 42, # Output only. Number of deployments in the app. "description": "A String", # Optional. Human-readable description of the app. "displayName": "A String", # Required. Display name of the app. + "errorHandlingSettings": { # Settings to describe how errors should be handled in the app. # Optional. Error handling settings of the app. + "errorHandlingStrategy": "A String", # Optional. The strategy to use for error handling. + }, "etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Optional. The evaluation thresholds for the app. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -2644,6 +2661,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -3120,13 +3141,13 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], }, }, - "name": "A String", # Identifier. The unique identifier of the tool. Format: - `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for ## standalone tools. `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only, they cannot be referenced directly where a tool is expected. + "name": "A String", # Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected. "openApiTool": { # A remote API tool defined by an OpenAPI schema. # Optional. The open API tool. "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required by the API. "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth. @@ -3165,7 +3186,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client will trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -3298,7 +3319,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -3341,7 +3362,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -3563,6 +3584,9 @@

Method Details

"deploymentCount": 42, # Output only. Number of deployments in the app. "description": "A String", # Optional. Human-readable description of the app. "displayName": "A String", # Required. Display name of the app. + "errorHandlingSettings": { # Settings to describe how errors should be handled in the app. # Optional. Error handling settings of the app. + "errorHandlingStrategy": "A String", # Optional. The strategy to use for error handling. + }, "etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Optional. The evaluation thresholds for the app. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -3734,6 +3758,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -4210,13 +4238,13 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], }, }, - "name": "A String", # Identifier. The unique identifier of the tool. Format: - `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for ## standalone tools. `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only, they cannot be referenced directly where a tool is expected. + "name": "A String", # Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected. "openApiTool": { # A remote API tool defined by an OpenAPI schema. # Optional. The open API tool. "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required by the API. "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth. @@ -4255,7 +4283,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client will trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -4388,7 +4416,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -4431,7 +4459,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.conversations.html b/docs/dyn/ces_v1beta.projects.locations.apps.conversations.html index 6d101179a3..482a3e9632 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.conversations.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.conversations.html @@ -249,6 +249,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -308,6 +312,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -419,6 +427,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -478,6 +490,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.deployments.html b/docs/dyn/ces_v1beta.projects.locations.apps.deployments.html index 8898dee827..45c1ee3ba1 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.deployments.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.deployments.html @@ -111,7 +111,7 @@

Method Details

The object takes the form of: { # A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile. - "appVersion": "A String", # Required. The resource name of the app version to deploy. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version} + "appVersion": "A String", # Optional. The resource name of the app version to deploy. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` Use `projects/{project}/locations/{location}/apps/{app}/versions/-` to use the draft app. "channelProfile": { # A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. # Required. The channel profile used in the deployment. "channelType": "A String", # Optional. The type of the channel profile. "disableBargeInControl": True or False, # Optional. Whether to disable user barge-in control in the conversation. - **true**: User interruptions are disabled while the agent is speaking. - **false**: The agent retains automatic control over when the user can interrupt. @@ -138,7 +138,7 @@

Method Details

"createTime": "A String", # Output only. Timestamp when this deployment was created. "displayName": "A String", # Required. Display name of the deployment. "etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. - "name": "A String", # Identifier. The resource name of the deployment. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment} + "name": "A String", # Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` "updateTime": "A String", # Output only. Timestamp when this deployment was last updated. } @@ -152,7 +152,7 @@

Method Details

An object of the form: { # A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile. - "appVersion": "A String", # Required. The resource name of the app version to deploy. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version} + "appVersion": "A String", # Optional. The resource name of the app version to deploy. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` Use `projects/{project}/locations/{location}/apps/{app}/versions/-` to use the draft app. "channelProfile": { # A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. # Required. The channel profile used in the deployment. "channelType": "A String", # Optional. The type of the channel profile. "disableBargeInControl": True or False, # Optional. Whether to disable user barge-in control in the conversation. - **true**: User interruptions are disabled while the agent is speaking. - **false**: The agent retains automatic control over when the user can interrupt. @@ -179,7 +179,7 @@

Method Details

"createTime": "A String", # Output only. Timestamp when this deployment was created. "displayName": "A String", # Required. Display name of the deployment. "etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. - "name": "A String", # Identifier. The resource name of the deployment. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment} + "name": "A String", # Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` "updateTime": "A String", # Output only. Timestamp when this deployment was last updated. }
@@ -218,7 +218,7 @@

Method Details

An object of the form: { # A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile. - "appVersion": "A String", # Required. The resource name of the app version to deploy. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version} + "appVersion": "A String", # Optional. The resource name of the app version to deploy. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` Use `projects/{project}/locations/{location}/apps/{app}/versions/-` to use the draft app. "channelProfile": { # A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. # Required. The channel profile used in the deployment. "channelType": "A String", # Optional. The type of the channel profile. "disableBargeInControl": True or False, # Optional. Whether to disable user barge-in control in the conversation. - **true**: User interruptions are disabled while the agent is speaking. - **false**: The agent retains automatic control over when the user can interrupt. @@ -245,7 +245,7 @@

Method Details

"createTime": "A String", # Output only. Timestamp when this deployment was created. "displayName": "A String", # Required. Display name of the deployment. "etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. - "name": "A String", # Identifier. The resource name of the deployment. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment} + "name": "A String", # Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` "updateTime": "A String", # Output only. Timestamp when this deployment was last updated. } @@ -270,7 +270,7 @@

Method Details

{ # Response message for AgentService.ListDeployments. "deployments": [ # The list of deployments. { # A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile. - "appVersion": "A String", # Required. The resource name of the app version to deploy. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version} + "appVersion": "A String", # Optional. The resource name of the app version to deploy. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` Use `projects/{project}/locations/{location}/apps/{app}/versions/-` to use the draft app. "channelProfile": { # A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. # Required. The channel profile used in the deployment. "channelType": "A String", # Optional. The type of the channel profile. "disableBargeInControl": True or False, # Optional. Whether to disable user barge-in control in the conversation. - **true**: User interruptions are disabled while the agent is speaking. - **false**: The agent retains automatic control over when the user can interrupt. @@ -297,7 +297,7 @@

Method Details

"createTime": "A String", # Output only. Timestamp when this deployment was created. "displayName": "A String", # Required. Display name of the deployment. "etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. - "name": "A String", # Identifier. The resource name of the deployment. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment} + "name": "A String", # Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` "updateTime": "A String", # Output only. Timestamp when this deployment was last updated. }, ], @@ -324,12 +324,12 @@

Method Details

Updates the specified deployment.
 
 Args:
-  name: string, Identifier. The resource name of the deployment. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment} (required)
+  name: string, Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` (required)
   body: object, The request body.
     The object takes the form of:
 
 { # A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile.
-  "appVersion": "A String", # Required. The resource name of the app version to deploy. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}
+  "appVersion": "A String", # Optional. The resource name of the app version to deploy. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` Use `projects/{project}/locations/{location}/apps/{app}/versions/-` to use the draft app.
   "channelProfile": { # A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. # Required. The channel profile used in the deployment.
     "channelType": "A String", # Optional. The type of the channel profile.
     "disableBargeInControl": True or False, # Optional. Whether to disable user barge-in control in the conversation. - **true**: User interruptions are disabled while the agent is speaking. - **false**: The agent retains automatic control over when the user can interrupt.
@@ -356,7 +356,7 @@ 

Method Details

"createTime": "A String", # Output only. Timestamp when this deployment was created. "displayName": "A String", # Required. Display name of the deployment. "etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. - "name": "A String", # Identifier. The resource name of the deployment. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment} + "name": "A String", # Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` "updateTime": "A String", # Output only. Timestamp when this deployment was last updated. } @@ -370,7 +370,7 @@

Method Details

An object of the form: { # A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile. - "appVersion": "A String", # Required. The resource name of the app version to deploy. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version} + "appVersion": "A String", # Optional. The resource name of the app version to deploy. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` Use `projects/{project}/locations/{location}/apps/{app}/versions/-` to use the draft app. "channelProfile": { # A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. # Required. The channel profile used in the deployment. "channelType": "A String", # Optional. The type of the channel profile. "disableBargeInControl": True or False, # Optional. Whether to disable user barge-in control in the conversation. - **true**: User interruptions are disabled while the agent is speaking. - **false**: The agent retains automatic control over when the user can interrupt. @@ -397,7 +397,7 @@

Method Details

"createTime": "A String", # Output only. Timestamp when this deployment was created. "displayName": "A String", # Required. Display name of the deployment. "etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. - "name": "A String", # Identifier. The resource name of the deployment. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment} + "name": "A String", # Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` "updateTime": "A String", # Output only. Timestamp when this deployment was last updated. }
diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.html b/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.html index 1decb22cbb..62223061d1 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.html @@ -100,6 +100,9 @@

Instance Methods

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates an evaluation.

+

+ uploadEvaluationAudio(name, body=None, x__xgafv=None)

+

Uploads audio for use in Golden Evaluations. Stores the audio in the Cloud Storage bucket defined in 'App.logging_settings.evaluation_audio_recording_config.gcs_bucket' and returns a transcript.

Method Details

close() @@ -229,6 +232,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -442,6 +449,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -538,6 +549,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -705,6 +720,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -783,6 +802,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -998,6 +1021,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -1094,6 +1121,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -1261,6 +1292,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -1339,6 +1374,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -1491,6 +1530,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -1705,6 +1748,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -1918,6 +1965,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -2014,6 +2065,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -2181,6 +2236,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -2259,6 +2318,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -2474,6 +2537,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -2570,6 +2637,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -2737,6 +2808,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -2815,6 +2890,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -2967,6 +3046,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -3207,6 +3290,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -3420,6 +3507,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -3516,6 +3607,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -3683,6 +3778,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -3761,6 +3860,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -3976,6 +4079,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -4072,6 +4179,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -4239,6 +4350,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -4317,6 +4432,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -4469,6 +4588,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -4698,6 +4821,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -4911,6 +5038,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -5007,6 +5138,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -5174,6 +5309,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -5252,6 +5391,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -5467,6 +5610,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -5563,6 +5710,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -5730,6 +5881,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -5808,6 +5963,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -5960,6 +6119,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -6192,6 +6355,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -6405,6 +6572,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -6501,6 +6672,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -6668,6 +6843,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -6746,6 +6925,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -6961,6 +7144,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -7057,6 +7244,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -7224,6 +7415,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -7302,6 +7497,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -7454,6 +7653,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -7668,6 +7871,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -7881,6 +8088,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -7977,6 +8188,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -8144,6 +8359,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -8222,6 +8441,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -8437,6 +8660,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -8533,6 +8760,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -8700,6 +8931,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -8778,6 +9013,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -8930,6 +9169,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -9022,4 +9265,33 @@

Method Details

}
+
+ uploadEvaluationAudio(name, body=None, x__xgafv=None) +
Uploads audio for use in Golden Evaluations. Stores the audio in the Cloud Storage bucket defined in 'App.logging_settings.evaluation_audio_recording_config.gcs_bucket' and returns a transcript.
+
+Args:
+  name: string, Required. The resource name of the Evaluation for which to upload the evaluation audio. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for EvaluationService.UploadEvaluationAudio.
+  "audioContent": "A String", # Required. The raw audio bytes. The format of the audio must be single-channel LINEAR16 with a sample rate of 16kHz (default InputAudioConfig).
+  "previousAudioGcsUri": "A String", # Optional. The Google Cloud Storage URI of the previously uploaded audio file to be deleted. Format: `gs:///`
+}
+
+  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 EvaluationService.UploadEvaluationAudio.
+  "audioGcsUri": "A String", # The Google Cloud Storage URI where the uploaded audio file is stored. Format: `gs:///`
+  "duration": "A String", # The duration of the audio.
+  "transcript": "A String", # The transcript of the audio, generated by Cloud Speech-to-Text.
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.results.html b/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.results.html index 1d37341921..ecfb9bbf9f 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.results.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.results.html @@ -209,6 +209,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -305,6 +309,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -472,6 +480,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -550,6 +562,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -786,6 +802,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -882,6 +902,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -1049,6 +1073,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -1127,6 +1155,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.examples.html b/docs/dyn/ces_v1beta.projects.locations.apps.examples.html index 1b5023f301..7761f50cc7 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.examples.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.examples.html @@ -125,6 +125,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -198,6 +202,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -296,6 +304,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -381,6 +393,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -472,6 +488,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -545,6 +565,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.html b/docs/dyn/ces_v1beta.projects.locations.apps.html index de1847cec2..809fb6ce0e 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.html @@ -266,6 +266,9 @@

Method Details

"deploymentCount": 42, # Output only. Number of deployments in the app. "description": "A String", # Optional. Human-readable description of the app. "displayName": "A String", # Required. Display name of the app. + "errorHandlingSettings": { # Settings to describe how errors should be handled in the app. # Optional. Error handling settings of the app. + "errorHandlingStrategy": "A String", # Optional. The strategy to use for error handling. + }, "etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Optional. The evaluation thresholds for the app. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -670,6 +673,9 @@

Method Details

"deploymentCount": 42, # Output only. Number of deployments in the app. "description": "A String", # Optional. Human-readable description of the app. "displayName": "A String", # Required. Display name of the app. + "errorHandlingSettings": { # Settings to describe how errors should be handled in the app. # Optional. Error handling settings of the app. + "errorHandlingStrategy": "A String", # Optional. The strategy to use for error handling. + }, "etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Optional. The evaluation thresholds for the app. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -1026,6 +1032,9 @@

Method Details

"deploymentCount": 42, # Output only. Number of deployments in the app. "description": "A String", # Optional. Human-readable description of the app. "displayName": "A String", # Required. Display name of the app. + "errorHandlingSettings": { # Settings to describe how errors should be handled in the app. # Optional. Error handling settings of the app. + "errorHandlingStrategy": "A String", # Optional. The strategy to use for error handling. + }, "etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Optional. The evaluation thresholds for the app. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -1291,6 +1300,9 @@

Method Details

"deploymentCount": 42, # Output only. Number of deployments in the app. "description": "A String", # Optional. Human-readable description of the app. "displayName": "A String", # Required. Display name of the app. + "errorHandlingSettings": { # Settings to describe how errors should be handled in the app. # Optional. Error handling settings of the app. + "errorHandlingStrategy": "A String", # Optional. The strategy to use for error handling. + }, "etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Optional. The evaluation thresholds for the app. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -1535,6 +1547,9 @@

Method Details

"deploymentCount": 42, # Output only. Number of deployments in the app. "description": "A String", # Optional. Human-readable description of the app. "displayName": "A String", # Required. Display name of the app. + "errorHandlingSettings": { # Settings to describe how errors should be handled in the app. # Optional. Error handling settings of the app. + "errorHandlingStrategy": "A String", # Optional. The strategy to use for error handling. + }, "etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Optional. The evaluation thresholds for the app. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.sessions.html b/docs/dyn/ces_v1beta.projects.locations.apps.sessions.html index 75653ac049..cc6e6c1d9d 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.sessions.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.sessions.html @@ -129,7 +129,7 @@

Method Details

{ # Request message for SessionService.RunSession. "config": { # The configuration for the session. # Required. The configuration for the session. "deployment": "A String", # Optional. The deployment of the app to use for the session. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` - "entryAgent": "A String", # Optional. The entry agent to handle the session. If not specified, the session will be handled by the root agent of the app. Format: `projects/{project}/locations/{location}/agents/{agent}` + "entryAgent": "A String", # Optional. The entry agent to handle the session. If not specified, the session will be handled by the root agent of the app. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` "historicalContexts": [ # Optional. The historical context of the session, including user inputs, agent responses, and other messages. Typically, CES agent would manage session automatically so client doesn't need to explicitly populate this field. However, client can optionally override the historical contexts to force the session start from certain state. { # A message within a conversation. "chunks": [ # Optional. Content of the message as a series of chunks. @@ -138,6 +138,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -204,6 +208,7 @@

Method Details

}, }, "timeZone": "A String", # Optional. The time zone of the user. If provided, the agent will use the time zone for date and time related variables. Otherwise, the agent will use the time zone specified in the App.time_zone_settings. The format is the IANA Time Zone Database time zone, e.g. "America/Los_Angeles". + "useToolFakes": True or False, # Optional. Whether to use tool fakes for the session. If this field is set, the agent will attempt use tool fakes instead of calling the real tools. }, "inputs": [ # Required. Inputs for the session. { # Input for the session. @@ -275,6 +280,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.tools.html b/docs/dyn/ces_v1beta.projects.locations.apps.tools.html index 075f4a4d0d..f0240ac3c2 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.tools.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.tools.html @@ -434,13 +434,13 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], }, }, - "name": "A String", # Identifier. The unique identifier of the tool. Format: - `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for ## standalone tools. `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only, they cannot be referenced directly where a tool is expected. + "name": "A String", # Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected. "openApiTool": { # A remote API tool defined by an OpenAPI schema. # Optional. The open API tool. "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required by the API. "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth. @@ -479,7 +479,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client will trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -875,13 +875,13 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], }, }, - "name": "A String", # Identifier. The unique identifier of the tool. Format: - `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for ## standalone tools. `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only, they cannot be referenced directly where a tool is expected. + "name": "A String", # Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected. "openApiTool": { # A remote API tool defined by an OpenAPI schema. # Optional. The open API tool. "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required by the API. "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth. @@ -920,7 +920,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client will trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -1342,13 +1342,13 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], }, }, - "name": "A String", # Identifier. The unique identifier of the tool. Format: - `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for ## standalone tools. `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only, they cannot be referenced directly where a tool is expected. + "name": "A String", # Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected. "openApiTool": { # A remote API tool defined by an OpenAPI schema. # Optional. The open API tool. "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required by the API. "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth. @@ -1387,7 +1387,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client will trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -1796,13 +1796,13 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], }, }, - "name": "A String", # Identifier. The unique identifier of the tool. Format: - `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for ## standalone tools. `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only, they cannot be referenced directly where a tool is expected. + "name": "A String", # Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected. "openApiTool": { # A remote API tool defined by an OpenAPI schema. # Optional. The open API tool. "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required by the API. "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth. @@ -1841,7 +1841,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client will trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -1926,7 +1926,7 @@

Method Details

Updates the specified tool.
 
 Args:
-  name: string, Identifier. The unique identifier of the tool. Format: - `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for ## standalone tools. `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only, they cannot be referenced directly where a tool is expected. (required)
+  name: string, Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -2254,13 +2254,13 @@ 

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], }, }, - "name": "A String", # Identifier. The unique identifier of the tool. Format: - `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for ## standalone tools. `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only, they cannot be referenced directly where a tool is expected. + "name": "A String", # Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected. "openApiTool": { # A remote API tool defined by an OpenAPI schema. # Optional. The open API tool. "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required by the API. "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth. @@ -2299,7 +2299,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client will trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -2695,13 +2695,13 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], }, }, - "name": "A String", # Identifier. The unique identifier of the tool. Format: - `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for ## standalone tools. `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only, they cannot be referenced directly where a tool is expected. + "name": "A String", # Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected. "openApiTool": { # A remote API tool defined by an OpenAPI schema. # Optional. The open API tool. "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required by the API. "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth. @@ -2740,7 +2740,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client will trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.toolsets.html b/docs/dyn/ces_v1beta.projects.locations.apps.toolsets.html index 94e2f7693e..fa0d70c126 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.toolsets.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.toolsets.html @@ -182,7 +182,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -225,7 +225,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -319,7 +319,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -362,7 +362,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -482,7 +482,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -525,7 +525,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -632,7 +632,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -675,7 +675,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -786,7 +786,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -829,7 +829,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -923,7 +923,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -966,7 +966,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -1332,13 +1332,13 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], }, }, - "name": "A String", # Identifier. The unique identifier of the tool. Format: - `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for ## standalone tools. `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only, they cannot be referenced directly where a tool is expected. + "name": "A String", # Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected. "openApiTool": { # A remote API tool defined by an OpenAPI schema. # Optional. The open API tool. "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required by the API. "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth. @@ -1377,7 +1377,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client will trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.versions.html b/docs/dyn/ces_v1beta.projects.locations.apps.versions.html index fa28def071..0b8ca15dca 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.versions.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.versions.html @@ -292,6 +292,9 @@

Method Details

"deploymentCount": 42, # Output only. Number of deployments in the app. "description": "A String", # Optional. Human-readable description of the app. "displayName": "A String", # Required. Display name of the app. + "errorHandlingSettings": { # Settings to describe how errors should be handled in the app. # Optional. Error handling settings of the app. + "errorHandlingStrategy": "A String", # Optional. The strategy to use for error handling. + }, "etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Optional. The evaluation thresholds for the app. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -482,6 +485,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -958,13 +965,13 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], }, }, - "name": "A String", # Identifier. The unique identifier of the tool. Format: - `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for ## standalone tools. `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only, they cannot be referenced directly where a tool is expected. + "name": "A String", # Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected. "openApiTool": { # A remote API tool defined by an OpenAPI schema. # Optional. The open API tool. "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required by the API. "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth. @@ -1003,7 +1010,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client will trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -1136,7 +1143,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -1179,7 +1186,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -1389,6 +1396,9 @@

Method Details

"deploymentCount": 42, # Output only. Number of deployments in the app. "description": "A String", # Optional. Human-readable description of the app. "displayName": "A String", # Required. Display name of the app. + "errorHandlingSettings": { # Settings to describe how errors should be handled in the app. # Optional. Error handling settings of the app. + "errorHandlingStrategy": "A String", # Optional. The strategy to use for error handling. + }, "etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Optional. The evaluation thresholds for the app. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -1579,6 +1589,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -2055,13 +2069,13 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], }, }, - "name": "A String", # Identifier. The unique identifier of the tool. Format: - `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for ## standalone tools. `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only, they cannot be referenced directly where a tool is expected. + "name": "A String", # Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected. "openApiTool": { # A remote API tool defined by an OpenAPI schema. # Optional. The open API tool. "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required by the API. "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth. @@ -2100,7 +2114,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client will trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -2233,7 +2247,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -2276,7 +2290,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -2511,6 +2525,9 @@

Method Details

"deploymentCount": 42, # Output only. Number of deployments in the app. "description": "A String", # Optional. Human-readable description of the app. "displayName": "A String", # Required. Display name of the app. + "errorHandlingSettings": { # Settings to describe how errors should be handled in the app. # Optional. Error handling settings of the app. + "errorHandlingStrategy": "A String", # Optional. The strategy to use for error handling. + }, "etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Optional. The evaluation thresholds for the app. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -2701,6 +2718,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -3177,13 +3198,13 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], }, }, - "name": "A String", # Identifier. The unique identifier of the tool. Format: - `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for ## standalone tools. `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only, they cannot be referenced directly where a tool is expected. + "name": "A String", # Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected. "openApiTool": { # A remote API tool defined by an OpenAPI schema. # Optional. The open API tool. "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required by the API. "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth. @@ -3222,7 +3243,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client will trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -3355,7 +3376,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -3398,7 +3419,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -3620,6 +3641,9 @@

Method Details

"deploymentCount": 42, # Output only. Number of deployments in the app. "description": "A String", # Optional. Human-readable description of the app. "displayName": "A String", # Required. Display name of the app. + "errorHandlingSettings": { # Settings to describe how errors should be handled in the app. # Optional. Error handling settings of the app. + "errorHandlingStrategy": "A String", # Optional. The strategy to use for error handling. + }, "etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Optional. The evaluation thresholds for the app. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -3810,6 +3834,10 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` }, + "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data. + "data": "A String", # Required. Raw bytes of the blob. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names. "a_key": "", # Properties of the object. }, @@ -4286,13 +4314,13 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], }, }, - "name": "A String", # Identifier. The unique identifier of the tool. Format: - `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for ## standalone tools. `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only, they cannot be referenced directly where a tool is expected. + "name": "A String", # Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected. "openApiTool": { # A remote API tool defined by an OpenAPI schema. # Optional. The open API tool. "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required by the API. "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth. @@ -4331,7 +4359,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client will trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -4464,7 +4492,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], @@ -4507,7 +4535,7 @@

Method Details

"tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. - "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. }, ], diff --git a/docs/dyn/ces_v1beta.projects.locations.html b/docs/dyn/ces_v1beta.projects.locations.html index 6e5a1e5ceb..a56f6191ed 100644 --- a/docs/dyn/ces_v1beta.projects.locations.html +++ b/docs/dyn/ces_v1beta.projects.locations.html @@ -90,12 +90,18 @@

Instance Methods

get(name, x__xgafv=None)

Gets information about a location.

+

+ getSecuritySettings(name, x__xgafv=None)

+

Retrieves the security settings for the project and location.

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

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

list_next()

Retrieves the next page of results.

+

+ updateSecuritySettings(name, body=None, updateMask=None, x__xgafv=None)

+

Updates the security settings for the project and location.

Method Details

close() @@ -129,6 +135,34 @@

Method Details

}
+
+ getSecuritySettings(name, x__xgafv=None) +
Retrieves the security settings for the project and location.
+
+Args:
+  name: string, Required. The resource name of the security settings to retrieve. Format: `projects/{project}/locations/{location}/securitySettings` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Project/Location level security settings for CES.
+  "createTime": "A String", # Output only. Create time of the security settings.
+  "endpointControlPolicy": { # Defines project/location level endpoint control policy. # Optional. Endpoint control related settings.
+    "allowedOrigins": [ # Optional. The allowed HTTP(s) origins that tools in the App are able to directly call. The enforcement depends on the value of enforcement_scope and the VPC-SC status of the project. If a port number is not provided, all ports will be allowed. Otherwise, the port number must match exactly. For example, "https://example.com" will match "https://example.com:443" and any other port. "https://example.com:443" will only match "https://example.com:443".
+      "A String",
+    ],
+    "enforcementScope": "A String", # Optional. The scope in which this policy's allowed_origins list is enforced.
+  },
+  "etag": "A String", # Output only. Etag of the security settings.
+  "name": "A String", # Identifier. The unique identifier of the security settings. Format: `projects/{project}/locations/{location}/securitySettings`
+  "updateTime": "A String", # Output only. Last update time of the security settings.
+}
+
+
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
@@ -179,4 +213,49 @@ 

Method Details

+
+ updateSecuritySettings(name, body=None, updateMask=None, x__xgafv=None) +
Updates the security settings for the project and location.
+
+Args:
+  name: string, Identifier. The unique identifier of the security settings. Format: `projects/{project}/locations/{location}/securitySettings` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Project/Location level security settings for CES.
+  "createTime": "A String", # Output only. Create time of the security settings.
+  "endpointControlPolicy": { # Defines project/location level endpoint control policy. # Optional. Endpoint control related settings.
+    "allowedOrigins": [ # Optional. The allowed HTTP(s) origins that tools in the App are able to directly call. The enforcement depends on the value of enforcement_scope and the VPC-SC status of the project. If a port number is not provided, all ports will be allowed. Otherwise, the port number must match exactly. For example, "https://example.com" will match "https://example.com:443" and any other port. "https://example.com:443" will only match "https://example.com:443".
+      "A String",
+    ],
+    "enforcementScope": "A String", # Optional. The scope in which this policy's allowed_origins list is enforced.
+  },
+  "etag": "A String", # Output only. Etag of the security settings.
+  "name": "A String", # Identifier. The unique identifier of the security settings. Format: `projects/{project}/locations/{location}/securitySettings`
+  "updateTime": "A String", # Output only. Last update time of the security settings.
+}
+
+  updateMask: string, Optional. Field mask is used to control which fields get updated. If the mask is not present, 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:
+
+    { # Project/Location level security settings for CES.
+  "createTime": "A String", # Output only. Create time of the security settings.
+  "endpointControlPolicy": { # Defines project/location level endpoint control policy. # Optional. Endpoint control related settings.
+    "allowedOrigins": [ # Optional. The allowed HTTP(s) origins that tools in the App are able to directly call. The enforcement depends on the value of enforcement_scope and the VPC-SC status of the project. If a port number is not provided, all ports will be allowed. Otherwise, the port number must match exactly. For example, "https://example.com" will match "https://example.com:443" and any other port. "https://example.com:443" will only match "https://example.com:443".
+      "A String",
+    ],
+    "enforcementScope": "A String", # Optional. The scope in which this policy's allowed_origins list is enforced.
+  },
+  "etag": "A String", # Output only. Etag of the security settings.
+  "name": "A String", # Identifier. The unique identifier of the security settings. Format: `projects/{project}/locations/{location}/securitySettings`
+  "updateTime": "A String", # Output only. Last update time of the security settings.
+}
+
+ \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/ces.v1.json b/googleapiclient/discovery_cache/documents/ces.v1.json index f9a66d03b7..020ea05867 100644 --- a/googleapiclient/discovery_cache/documents/ces.v1.json +++ b/googleapiclient/discovery_cache/documents/ces.v1.json @@ -1095,7 +1095,7 @@ ], "parameters": { "name": { -"description": "Identifier. The resource name of the deployment. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}", +"description": "Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$", "required": true, @@ -1698,7 +1698,7 @@ ], "parameters": { "name": { -"description": "Identifier. The unique identifier of the tool. Format: - `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for ## standalone tools. `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only, they cannot be referenced directly where a tool is expected.", +"description": "Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/tools/[^/]+$", "required": true, @@ -2246,7 +2246,7 @@ } } }, -"revision": "20260218", +"revision": "20260227", "rootUrl": "https://ces.googleapis.com/", "schemas": { "Action": { @@ -2652,6 +2652,10 @@ "description": "Required. Display name of the app.", "type": "string" }, +"errorHandlingSettings": { +"$ref": "ErrorHandlingSettings", +"description": "Optional. Error handling settings of the app." +}, "etag": { "description": "Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.", "readOnly": true, @@ -3239,6 +3243,10 @@ "$ref": "AgentTransfer", "description": "Optional. Agent transfer event." }, +"blob": { +"$ref": "Blob", +"description": "Optional. Blob data." +}, "defaultVariables": { "additionalProperties": { "description": "Properties of the object.", @@ -4002,7 +4010,7 @@ "id": "Deployment", "properties": { "appVersion": { -"description": "Required. The resource name of the app version to deploy. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}", +"description": "Optional. The resource name of the app version to deploy. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` Use `projects/{project}/locations/{location}/apps/{app}/versions/-` to use the draft app.", "type": "string" }, "channelProfile": { @@ -4025,7 +4033,7 @@ "type": "string" }, "name": { -"description": "Identifier. The resource name of the deployment. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}", +"description": "Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`", "type": "string" }, "updateTime": { @@ -4103,6 +4111,55 @@ }, "type": "object" }, +"EndpointControlPolicy": { +"description": "Defines project/location level endpoint control policy.", +"id": "EndpointControlPolicy", +"properties": { +"allowedOrigins": { +"description": "Optional. The allowed HTTP(s) origins that tools in the App are able to directly call. The enforcement depends on the value of enforcement_scope and the VPC-SC status of the project. If a port number is not provided, all ports will be allowed. Otherwise, the port number must match exactly. For example, \"https://example.com\" will match \"https://example.com:443\" and any other port. \"https://example.com:443\" will only match \"https://example.com:443\".", +"items": { +"type": "string" +}, +"type": "array" +}, +"enforcementScope": { +"description": "Optional. The scope in which this policy's allowed_origins list is enforced.", +"enum": [ +"ENFORCEMENT_SCOPE_UNSPECIFIED", +"VPCSC_ONLY", +"ALWAYS" +], +"enumDescriptions": [ +"Unspecified. This policy will be treated as VPCSC_ONLY.", +"This policy applies only when VPC-SC is active.", +"This policy ALWAYS applies, regardless of VPC-SC status." +], +"type": "string" +} +}, +"type": "object" +}, +"ErrorHandlingSettings": { +"description": "Settings to describe how errors should be handled in the app.", +"id": "ErrorHandlingSettings", +"properties": { +"errorHandlingStrategy": { +"description": "Optional. The strategy to use for error handling.", +"enum": [ +"ERROR_HANDLING_STRATEGY_UNSPECIFIED", +"NONE", +"FALLBACK_RESPONSE" +], +"enumDescriptions": [ +"Unspecified error handling strategy. Defaults to FALLBACK_RESPONSE.", +"No specific handling is enabled.", +"A fallback message will be returned to the user in case of LLM errors." +], +"type": "string" +} +}, +"type": "object" +}, "EvaluationMetricsThresholds": { "description": "Threshold settings for metrics in an Evaluation.", "id": "EvaluationMetricsThresholds", @@ -6029,6 +6086,38 @@ }, "type": "object" }, +"SecuritySettings": { +"description": "Project/Location level security settings for CES.", +"id": "SecuritySettings", +"properties": { +"createTime": { +"description": "Output only. Create time of the security settings.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endpointControlPolicy": { +"$ref": "EndpointControlPolicy", +"description": "Optional. Endpoint control related settings." +}, +"etag": { +"description": "Output only. Etag of the security settings.", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. The unique identifier of the security settings. Format: `projects/{project}/locations/{location}/securitySettings`", +"type": "string" +}, +"updateTime": { +"description": "Output only. Last update time of the security settings.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "ServiceAccountAuthConfig": { "description": "Configurations for authentication using a custom service account.", "id": "ServiceAccountAuthConfig", @@ -6073,7 +6162,7 @@ "type": "string" }, "entryAgent": { -"description": "Optional. The entry agent to handle the session. If not specified, the session will be handled by the root agent of the app. Format: `projects/{project}/locations/{location}/agents/{agent}`", +"description": "Optional. The entry agent to handle the session. If not specified, the session will be handled by the root agent of the app. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`", "type": "string" }, "historicalContexts": { @@ -6098,6 +6187,10 @@ "timeZone": { "description": "Optional. The time zone of the user. If provided, the agent will use the time zone for date and time related variables. Otherwise, the agent will use the time zone specified in the App.time_zone_settings. The format is the IANA Time Zone Database time zone, e.g. \"America/Los_Angeles\".", "type": "string" +}, +"useToolFakes": { +"description": "Optional. Whether to use tool fakes for the session. If this field is set, the agent will attempt use tool fakes instead of calling the real tools.", +"type": "boolean" } }, "type": "object" @@ -6387,7 +6480,7 @@ "id": "TlsConfigCaCert", "properties": { "cert": { -"description": "Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with \"subject alt name\". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \\ -signkey example.com.key \\ -out example.com.crt \\ -extfile <(printf \"\\nsubjectAltName='DNS:www.example.com'\")", +"description": "Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with \"subject alt name\". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \\ -signkey example.com.key \\ -out example.com.crt \\ -extfile <(printf \"\\nsubjectAltName='DNS:www.example.com'\") ```", "format": "byte", "type": "string" }, @@ -6461,7 +6554,7 @@ "description": "Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset." }, "name": { -"description": "Identifier. The unique identifier of the tool. Format: - `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for ## standalone tools. `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only, they cannot be referenced directly where a tool is expected.", +"description": "Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected.", "type": "string" }, "openApiTool": { diff --git a/googleapiclient/discovery_cache/documents/ces.v1beta.json b/googleapiclient/discovery_cache/documents/ces.v1beta.json index 2823eb8c13..6d0c6a7fb1 100644 --- a/googleapiclient/discovery_cache/documents/ces.v1beta.json +++ b/googleapiclient/discovery_cache/documents/ces.v1beta.json @@ -150,6 +150,32 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"getSecuritySettings": { +"description": "Retrieves the security settings for the project and location.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/securitySettings", +"httpMethod": "GET", +"id": "ces.projects.locations.getSecuritySettings", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the security settings to retrieve. Format: `projects/{project}/locations/{location}/securitySettings`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/securitySettings$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "SecuritySettings" +}, +"scopes": [ +"https://www.googleapis.com/auth/ces", +"https://www.googleapis.com/auth/cloud-platform" +] +}, "list": { "description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", "flatPath": "v1beta/projects/{projectsId}/locations", @@ -197,6 +223,41 @@ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] +}, +"updateSecuritySettings": { +"description": "Updates the security settings for the project and location.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/securitySettings", +"httpMethod": "PATCH", +"id": "ces.projects.locations.updateSecuritySettings", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The unique identifier of the security settings. Format: `projects/{project}/locations/{location}/securitySettings`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/securitySettings$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+name}", +"request": { +"$ref": "SecuritySettings" +}, +"response": { +"$ref": "SecuritySettings" +}, +"scopes": [ +"https://www.googleapis.com/auth/ces", +"https://www.googleapis.com/auth/cloud-platform" +] } }, "resources": { @@ -1211,7 +1272,7 @@ ], "parameters": { "name": { -"description": "Identifier. The resource name of the deployment. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}", +"description": "Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$", "required": true, @@ -1890,6 +1951,35 @@ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] +}, +"uploadEvaluationAudio": { +"description": "Uploads audio for use in Golden Evaluations. Stores the audio in the Cloud Storage bucket defined in 'App.logging_settings.evaluation_audio_recording_config.gcs_bucket' and returns a transcript.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}:uploadEvaluationAudio", +"httpMethod": "POST", +"id": "ces.projects.locations.apps.evaluations.uploadEvaluationAudio", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the Evaluation for which to upload the evaluation audio. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}:uploadEvaluationAudio", +"request": { +"$ref": "UploadEvaluationAudioRequest" +}, +"response": { +"$ref": "UploadEvaluationAudioResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/ces", +"https://www.googleapis.com/auth/cloud-platform" +] } }, "resources": { @@ -2751,7 +2841,7 @@ ], "parameters": { "name": { -"description": "Identifier. The unique identifier of the tool. Format: - `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for ## standalone tools. `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only, they cannot be referenced directly where a tool is expected.", +"description": "Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/tools/[^/]+$", "required": true, @@ -3299,7 +3389,7 @@ } } }, -"revision": "20260218", +"revision": "20260227", "rootUrl": "https://ces.googleapis.com/", "schemas": { "Action": { @@ -3926,6 +4016,10 @@ "description": "Required. Display name of the app.", "type": "string" }, +"errorHandlingSettings": { +"$ref": "ErrorHandlingSettings", +"description": "Optional. Error handling settings of the app." +}, "etag": { "description": "Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.", "readOnly": true, @@ -4552,6 +4646,10 @@ "$ref": "AgentTransfer", "description": "Optional. Agent transfer event." }, +"blob": { +"$ref": "Blob", +"description": "Optional. Blob data." +}, "defaultVariables": { "additionalProperties": { "description": "Properties of the object.", @@ -5321,7 +5419,7 @@ "id": "Deployment", "properties": { "appVersion": { -"description": "Required. The resource name of the app version to deploy. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}", +"description": "Optional. The resource name of the app version to deploy. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` Use `projects/{project}/locations/{location}/apps/{app}/versions/-` to use the draft app.", "type": "string" }, "channelProfile": { @@ -5344,7 +5442,7 @@ "type": "string" }, "name": { -"description": "Identifier. The resource name of the deployment. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}", +"description": "Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`", "type": "string" }, "updateTime": { @@ -5422,6 +5520,55 @@ }, "type": "object" }, +"EndpointControlPolicy": { +"description": "Defines project/location level endpoint control policy.", +"id": "EndpointControlPolicy", +"properties": { +"allowedOrigins": { +"description": "Optional. The allowed HTTP(s) origins that tools in the App are able to directly call. The enforcement depends on the value of enforcement_scope and the VPC-SC status of the project. If a port number is not provided, all ports will be allowed. Otherwise, the port number must match exactly. For example, \"https://example.com\" will match \"https://example.com:443\" and any other port. \"https://example.com:443\" will only match \"https://example.com:443\".", +"items": { +"type": "string" +}, +"type": "array" +}, +"enforcementScope": { +"description": "Optional. The scope in which this policy's allowed_origins list is enforced.", +"enum": [ +"ENFORCEMENT_SCOPE_UNSPECIFIED", +"VPCSC_ONLY", +"ALWAYS" +], +"enumDescriptions": [ +"Unspecified. This policy will be treated as VPCSC_ONLY.", +"This policy applies only when VPC-SC is active.", +"This policy ALWAYS applies, regardless of VPC-SC status." +], +"type": "string" +} +}, +"type": "object" +}, +"ErrorHandlingSettings": { +"description": "Settings to describe how errors should be handled in the app.", +"id": "ErrorHandlingSettings", +"properties": { +"errorHandlingStrategy": { +"description": "Optional. The strategy to use for error handling.", +"enum": [ +"ERROR_HANDLING_STRATEGY_UNSPECIFIED", +"NONE", +"FALLBACK_RESPONSE" +], +"enumDescriptions": [ +"Unspecified error handling strategy. Defaults to FALLBACK_RESPONSE.", +"No specific handling is enabled.", +"A fallback message will be returned to the user in case of LLM errors." +], +"type": "string" +} +}, +"type": "object" +}, "Evaluation": { "description": "An evaluation represents all of the information needed to simulate and evaluate an agent.", "id": "Evaluation", @@ -9754,6 +9901,38 @@ }, "type": "object" }, +"SecuritySettings": { +"description": "Project/Location level security settings for CES.", +"id": "SecuritySettings", +"properties": { +"createTime": { +"description": "Output only. Create time of the security settings.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endpointControlPolicy": { +"$ref": "EndpointControlPolicy", +"description": "Optional. Endpoint control related settings." +}, +"etag": { +"description": "Output only. Etag of the security settings.", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. The unique identifier of the security settings. Format: `projects/{project}/locations/{location}/securitySettings`", +"type": "string" +}, +"updateTime": { +"description": "Output only. Last update time of the security settings.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "ServiceAccountAuthConfig": { "description": "Configurations for authentication using a custom service account.", "id": "ServiceAccountAuthConfig", @@ -9798,7 +9977,7 @@ "type": "string" }, "entryAgent": { -"description": "Optional. The entry agent to handle the session. If not specified, the session will be handled by the root agent of the app. Format: `projects/{project}/locations/{location}/agents/{agent}`", +"description": "Optional. The entry agent to handle the session. If not specified, the session will be handled by the root agent of the app. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`", "type": "string" }, "historicalContexts": { @@ -9823,6 +10002,10 @@ "timeZone": { "description": "Optional. The time zone of the user. If provided, the agent will use the time zone for date and time related variables. Otherwise, the agent will use the time zone specified in the App.time_zone_settings. The format is the IANA Time Zone Database time zone, e.g. \"America/Los_Angeles\".", "type": "string" +}, +"useToolFakes": { +"description": "Optional. Whether to use tool fakes for the session. If this field is set, the agent will attempt use tool fakes instead of calling the real tools.", +"type": "boolean" } }, "type": "object" @@ -10139,7 +10322,7 @@ "id": "TlsConfigCaCert", "properties": { "cert": { -"description": "Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with \"subject alt name\". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \\ -signkey example.com.key \\ -out example.com.crt \\ -extfile <(printf \"\\nsubjectAltName='DNS:www.example.com'\")", +"description": "Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with \"subject alt name\". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \\ -signkey example.com.key \\ -out example.com.crt \\ -extfile <(printf \"\\nsubjectAltName='DNS:www.example.com'\") ```", "format": "byte", "type": "string" }, @@ -10213,7 +10396,7 @@ "description": "Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset." }, "name": { -"description": "Identifier. The unique identifier of the tool. Format: - `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for ## standalone tools. `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only, they cannot be referenced directly where a tool is expected.", +"description": "Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected.", "type": "string" }, "openApiTool": { @@ -10561,6 +10744,42 @@ }, "type": "object" }, +"UploadEvaluationAudioRequest": { +"description": "Request message for EvaluationService.UploadEvaluationAudio.", +"id": "UploadEvaluationAudioRequest", +"properties": { +"audioContent": { +"description": "Required. The raw audio bytes. The format of the audio must be single-channel LINEAR16 with a sample rate of 16kHz (default InputAudioConfig).", +"format": "byte", +"type": "string" +}, +"previousAudioGcsUri": { +"description": "Optional. The Google Cloud Storage URI of the previously uploaded audio file to be deleted. Format: `gs:///`", +"type": "string" +} +}, +"type": "object" +}, +"UploadEvaluationAudioResponse": { +"description": "Response message for EvaluationService.UploadEvaluationAudio.", +"id": "UploadEvaluationAudioResponse", +"properties": { +"audioGcsUri": { +"description": "The Google Cloud Storage URI where the uploaded audio file is stored. Format: `gs:///`", +"type": "string" +}, +"duration": { +"description": "The duration of the audio.", +"format": "google-duration", +"type": "string" +}, +"transcript": { +"description": "The transcript of the audio, generated by Cloud Speech-to-Text.", +"type": "string" +} +}, +"type": "object" +}, "WebSearchQuery": { "description": "Represents a single web search query and its associated search uri.", "id": "WebSearchQuery", From f18dffb3fabc828fe4134eb63ba2bc253951f44e Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 10 Mar 2026 07:24:04 +0000 Subject: [PATCH 09/31] feat(compute): update the api #### compute:alpha The following keys were added: - resources.disks.methods.updateKmsKey.request.$ref (Total Keys: 1) - resources.regionDisks.methods.updateKmsKey.request.$ref (Total Keys: 1) - resources.regionSnapshots.methods.updateKmsKey.request.$ref (Total Keys: 1) - resources.snapshots.methods.updateKmsKey.request.$ref (Total Keys: 1) - schemas.Commitment.properties.params.$ref (Total Keys: 1) - schemas.CommitmentParams (Total Keys: 4) - schemas.DiskUpdateKmsKeyRequest (Total Keys: 3) - schemas.FutureReservation.properties.params.$ref (Total Keys: 1) - schemas.FutureReservationParams (Total Keys: 4) - schemas.GlobalVmExtensionPolicyRolloutOperationRolloutStatusRolloutMetadata.properties.locationRolloutStatus (Total Keys: 3) - schemas.GlobalVmExtensionPolicyRolloutOperationRolloutStatusRolloutMetadataLocationRolloutStatus (Total Keys: 4) - schemas.HttpRouteAction.properties.imageOptimizationPolicy.$ref (Total Keys: 1) - schemas.ImageOptimizationPolicy (Total Keys: 3) - schemas.NetworkInterface.properties.aliasIpv6Ranges (Total Keys: 2) - schemas.RegionDiskUpdateKmsKeyRequest (Total Keys: 3) - schemas.RegionSnapshotUpdateKmsKeyRequest (Total Keys: 3) - schemas.RolloutWaveDetailsOrchestratedWaveDetails.properties.estimatedCompletionTime (Total Keys: 2) - schemas.RolloutWaveDetailsOrchestratedWaveDetails.properties.locationStatus (Total Keys: 3) - schemas.RolloutWaveDetailsOrchestratedWaveDetailsLocationStatus (Total Keys: 4) - schemas.SnapshotUpdateKmsKeyRequest (Total Keys: 3) - schemas.Subnetwork.properties.ipv6NetworkTier.type (Total Keys: 1) - schemas.UpcomingMaintenance.properties.maintenanceMethod (Total Keys: 2) #### compute:beta The following keys were added: - resources.instances.methods.update.parameters.discardLocalSsd (Total Keys: 2) - resources.regionHealthCheckServices.methods.aggregatedList (Total Keys: 29) - resources.regionNotificationEndpoints.methods.aggregatedList (Total Keys: 29) - resources.reservationSlots.methods.getVersion (Total Keys: 23) - resources.reservationSubBlocks.methods.getVersion (Total Keys: 23) - schemas.BackendServiceDynamicForwarding.properties.forwardProxy.$ref (Total Keys: 1) - schemas.BackendServiceDynamicForwardingForwardProxy (Total Keys: 4) - schemas.GetVersionOperationMetadata (Total Keys: 9) - schemas.GlobalVmExtensionPolicyRolloutOperationRolloutStatusRolloutMetadata.properties.locationRolloutStatus (Total Keys: 3) - schemas.GlobalVmExtensionPolicyRolloutOperationRolloutStatusRolloutMetadataLocationRolloutStatus (Total Keys: 4) - schemas.HealthCheckServiceAggregatedList (Total Keys: 21) - schemas.HealthCheckServicesScopedList (Total Keys: 11) - schemas.InstanceGroupManagerStatus.properties.appliedAcceleratorTopologies (Total Keys: 3) - schemas.InstanceGroupManagerStatusAcceleratorTopology (Total Keys: 26) - schemas.NotificationEndpointAggregatedList (Total Keys: 21) - schemas.NotificationEndpointsScopedList (Total Keys: 11) - schemas.Operation.properties.getVersionOperationMetadata.$ref (Total Keys: 1) - schemas.ReservationSlotsGetVersionRequest (Total Keys: 4) - schemas.ReservationSubBlocksGetVersionRequest (Total Keys: 4) #### compute:v1 The following keys were added: - resources.instances.methods.update.parameters.discardLocalSsd (Total Keys: 2) - resources.regionCompositeHealthChecks.methods.aggregatedList (Total Keys: 29) - resources.regionCompositeHealthChecks.methods.delete (Total Keys: 21) - resources.regionCompositeHealthChecks.methods.get (Total Keys: 19) - resources.regionCompositeHealthChecks.methods.insert (Total Keys: 18) - resources.regionCompositeHealthChecks.methods.list (Total Keys: 28) - resources.regionCompositeHealthChecks.methods.patch (Total Keys: 21) - resources.regionCompositeHealthChecks.methods.testIamPermissions (Total Keys: 20) - resources.regionHealthCheckServices.methods.aggregatedList (Total Keys: 29) - resources.regionHealthSources.methods.aggregatedList (Total Keys: 29) - resources.regionHealthSources.methods.delete (Total Keys: 21) - resources.regionHealthSources.methods.get (Total Keys: 19) - resources.regionHealthSources.methods.insert (Total Keys: 18) - resources.regionHealthSources.methods.list (Total Keys: 28) - resources.regionHealthSources.methods.patch (Total Keys: 21) - resources.regionHealthSources.methods.testIamPermissions (Total Keys: 20) - resources.regionNotificationEndpoints.methods.aggregatedList (Total Keys: 29) - resources.reservationSlots.methods.getVersion (Total Keys: 23) - resources.reservationSubBlocks.methods.getVersion (Total Keys: 23) - schemas.CompositeHealthCheck (Total Keys: 72) - schemas.GetVersionOperationMetadata (Total Keys: 9) - schemas.HealthCheckServiceAggregatedList (Total Keys: 21) - schemas.HealthCheckServicesScopedList (Total Keys: 11) - schemas.HealthSource (Total Keys: 73) - schemas.InstanceGroupManager.properties.targetSizePolicy.$ref (Total Keys: 1) - schemas.InstanceGroupManagerStatus.properties.appliedAcceleratorTopologies (Total Keys: 3) - schemas.InstanceGroupManagerStatus.properties.bulkInstanceOperation (Total Keys: 2) - schemas.InstanceGroupManagerStatusAcceleratorTopology (Total Keys: 26) - schemas.InstanceGroupManagerStatusBulkInstanceOperation (Total Keys: 24) - schemas.InstanceGroupManagerTargetSizePolicy (Total Keys: 3) - schemas.NotificationEndpointAggregatedList (Total Keys: 21) - schemas.NotificationEndpointsScopedList (Total Keys: 11) - schemas.Operation.properties.getVersionOperationMetadata.$ref (Total Keys: 1) - schemas.ReservationSlotsGetVersionRequest (Total Keys: 4) - schemas.ReservationSubBlocksGetVersionRequest (Total Keys: 4) - schemas.ResourcePolicyWorkloadPolicy.properties.acceleratorTopologyMode.type (Total Keys: 1) - schemas.ServiceAttachmentConnectedEndpoint.properties.endpointWithId.type (Total Keys: 1) --- docs/dyn/compute_alpha.backendServices.html | 26 +- docs/dyn/compute_alpha.disks.html | 22 +- .../dyn/compute_alpha.futureReservations.html | 60 + ...mpute_alpha.globalVmExtensionPolicies.html | 83 +- .../compute_alpha.instanceGroupManagers.html | 30 + docs/dyn/compute_alpha.instanceTemplates.html | 44 + docs/dyn/compute_alpha.instances.html | 98 + docs/dyn/compute_alpha.machineImages.html | 66 + docs/dyn/compute_alpha.nodeGroups.html | 1 + ...te_alpha.organizationSecurityPolicies.html | 48 +- .../compute_alpha.regionBackendServices.html | 12 +- docs/dyn/compute_alpha.regionCommitments.html | 66 + docs/dyn/compute_alpha.regionDisks.html | 22 +- ...ute_alpha.regionInstanceGroupManagers.html | 25 + ...compute_alpha.regionInstanceTemplates.html | 33 + docs/dyn/compute_alpha.regionInstances.html | 11 + .../compute_alpha.regionSecurityPolicies.html | 48 +- docs/dyn/compute_alpha.regionSnapshots.html | 18 +- docs/dyn/compute_alpha.regionSslPolicies.html | 48 +- docs/dyn/compute_alpha.regionUrlMaps.html | 264 ++ docs/dyn/compute_alpha.reservationBlocks.html | 2 + .../compute_alpha.reservationSubBlocks.html | 2 + docs/dyn/compute_alpha.reservations.html | 5 + docs/dyn/compute_alpha.rollouts.html | 16 + docs/dyn/compute_alpha.securityPolicies.html | 60 +- docs/dyn/compute_alpha.snapshots.html | 18 +- docs/dyn/compute_alpha.sslPolicies.html | 60 +- docs/dyn/compute_alpha.subnetworks.html | 20 + docs/dyn/compute_alpha.urlMaps.html | 308 ++ .../compute_alpha.zoneQueuedResources.html | 44 + docs/dyn/compute_beta.addresses.html | 48 + docs/dyn/compute_beta.autoscalers.html | 48 + docs/dyn/compute_beta.backendBuckets.html | 84 + docs/dyn/compute_beta.backendServices.html | 150 +- docs/dyn/compute_beta.crossSiteNetworks.html | 36 + docs/dyn/compute_beta.diskSettings.html | 12 + docs/dyn/compute_beta.disks.html | 156 + .../dyn/compute_beta.externalVpnGateways.html | 36 + docs/dyn/compute_beta.firewallPolicies.html | 156 + docs/dyn/compute_beta.firewalls.html | 48 + docs/dyn/compute_beta.forwardingRules.html | 60 + docs/dyn/compute_beta.futureReservations.html | 48 + docs/dyn/compute_beta.globalAddresses.html | 48 + .../compute_beta.globalForwardingRules.html | 60 + ...pute_beta.globalNetworkEndpointGroups.html | 48 + docs/dyn/compute_beta.globalOperations.html | 48 + ...ute_beta.globalOrganizationOperations.html | 24 + ...te_beta.globalPublicDelegatedPrefixes.html | 36 + ...ompute_beta.globalVmExtensionPolicies.html | 119 +- docs/dyn/compute_beta.healthChecks.html | 48 + docs/dyn/compute_beta.httpHealthChecks.html | 48 + docs/dyn/compute_beta.httpsHealthChecks.html | 48 + docs/dyn/compute_beta.images.html | 60 + ...ta.instanceGroupManagerResizeRequests.html | 36 + .../compute_beta.instanceGroupManagers.html | 960 ++++ docs/dyn/compute_beta.instanceGroups.html | 60 + docs/dyn/compute_beta.instanceSettings.html | 12 + docs/dyn/compute_beta.instanceTemplates.html | 24 + docs/dyn/compute_beta.instances.html | 498 +- .../compute_beta.instantSnapshotGroups.html | 24 + docs/dyn/compute_beta.instantSnapshots.html | 36 + ...ute_beta.interconnectAttachmentGroups.html | 36 + .../compute_beta.interconnectAttachments.html | 48 + docs/dyn/compute_beta.interconnectGroups.html | 48 + docs/dyn/compute_beta.interconnects.html | 48 + docs/dyn/compute_beta.licenses.html | 36 + docs/dyn/compute_beta.machineImages.html | 36 + docs/dyn/compute_beta.networkAttachments.html | 36 + ...pute_beta.networkEdgeSecurityServices.html | 36 + .../compute_beta.networkEndpointGroups.html | 48 + .../compute_beta.networkFirewallPolicies.html | 144 + docs/dyn/compute_beta.networks.html | 108 + docs/dyn/compute_beta.nodeGroups.html | 96 + docs/dyn/compute_beta.nodeTemplates.html | 24 + ...ute_beta.organizationSecurityPolicies.html | 168 +- docs/dyn/compute_beta.packetMirrorings.html | 36 + docs/dyn/compute_beta.previewFeatures.html | 12 + docs/dyn/compute_beta.projects.html | 132 + ...compute_beta.publicAdvertisedPrefixes.html | 60 + .../compute_beta.publicDelegatedPrefixes.html | 60 + docs/dyn/compute_beta.regionAutoscalers.html | 48 + .../compute_beta.regionBackendBuckets.html | 36 + .../compute_beta.regionBackendServices.html | 96 +- docs/dyn/compute_beta.regionCommitments.html | 36 + ...pute_beta.regionCompositeHealthChecks.html | 36 + docs/dyn/compute_beta.regionDiskSettings.html | 12 + docs/dyn/compute_beta.regionDisks.html | 144 + ..._beta.regionHealthAggregationPolicies.html | 36 + ...ompute_beta.regionHealthCheckServices.html | 312 ++ docs/dyn/compute_beta.regionHealthChecks.html | 48 + .../dyn/compute_beta.regionHealthSources.html | 36 + ...ionInstanceGroupManagerResizeRequests.html | 36 + ...pute_beta.regionInstanceGroupManagers.html | 844 ++++ .../compute_beta.regionInstanceGroups.html | 12 + .../compute_beta.regionInstanceTemplates.html | 24 + docs/dyn/compute_beta.regionInstances.html | 12 + ...pute_beta.regionInstantSnapshotGroups.html | 24 + .../compute_beta.regionInstantSnapshots.html | 36 + docs/dyn/compute_beta.regionMultiMigs.html | 24 + ...pute_beta.regionNetworkEndpointGroups.html | 48 + ...te_beta.regionNetworkFirewallPolicies.html | 120 + .../compute_beta.regionNetworkPolicies.html | 96 + ...pute_beta.regionNotificationEndpoints.html | 281 ++ docs/dyn/compute_beta.regionOperations.html | 36 + .../compute_beta.regionSecurityPolicies.html | 132 +- .../compute_beta.regionSnapshotSettings.html | 12 + docs/dyn/compute_beta.regionSnapshots.html | 36 + .../compute_beta.regionSslCertificates.html | 24 + docs/dyn/compute_beta.regionSslPolicies.html | 56 +- .../compute_beta.regionTargetHttpProxies.html | 36 + ...compute_beta.regionTargetHttpsProxies.html | 60 + .../compute_beta.regionTargetTcpProxies.html | 24 + docs/dyn/compute_beta.regionUrlMaps.html | 60 + docs/dyn/compute_beta.reservationBlocks.html | 12 + docs/dyn/compute_beta.reservationSlots.html | 320 ++ .../compute_beta.reservationSubBlocks.html | 332 ++ docs/dyn/compute_beta.reservations.html | 60 + docs/dyn/compute_beta.resourcePolicies.html | 36 + docs/dyn/compute_beta.rolloutPlans.html | 24 + docs/dyn/compute_beta.rollouts.html | 24 + docs/dyn/compute_beta.routers.html | 120 + docs/dyn/compute_beta.routes.html | 24 + docs/dyn/compute_beta.securityPolicies.html | 144 +- docs/dyn/compute_beta.serviceAttachments.html | 36 + docs/dyn/compute_beta.snapshotGroups.html | 24 + docs/dyn/compute_beta.snapshotSettings.html | 12 + docs/dyn/compute_beta.snapshots.html | 36 + docs/dyn/compute_beta.sslCertificates.html | 24 + docs/dyn/compute_beta.sslPolicies.html | 61 +- docs/dyn/compute_beta.storagePools.html | 36 + docs/dyn/compute_beta.subnetworks.html | 60 + docs/dyn/compute_beta.targetGrpcProxies.html | 36 + docs/dyn/compute_beta.targetHttpProxies.html | 48 + docs/dyn/compute_beta.targetHttpsProxies.html | 96 + docs/dyn/compute_beta.targetInstances.html | 36 + docs/dyn/compute_beta.targetPools.html | 96 + docs/dyn/compute_beta.targetSslProxies.html | 84 + docs/dyn/compute_beta.targetTcpProxies.html | 48 + docs/dyn/compute_beta.targetVpnGateways.html | 36 + docs/dyn/compute_beta.urlMaps.html | 60 + docs/dyn/compute_beta.vpnGateways.html | 36 + docs/dyn/compute_beta.vpnTunnels.html | 36 + docs/dyn/compute_beta.wireGroups.html | 36 + docs/dyn/compute_beta.zoneOperations.html | 36 + .../compute_beta.zoneVmExtensionPolicies.html | 36 + docs/dyn/compute_v1.addresses.html | 48 + docs/dyn/compute_v1.autoscalers.html | 48 + docs/dyn/compute_v1.backendBuckets.html | 84 + docs/dyn/compute_v1.backendServices.html | 110 +- docs/dyn/compute_v1.crossSiteNetworks.html | 36 + docs/dyn/compute_v1.disks.html | 156 + docs/dyn/compute_v1.externalVpnGateways.html | 36 + docs/dyn/compute_v1.firewallPolicies.html | 120 + docs/dyn/compute_v1.firewalls.html | 48 + docs/dyn/compute_v1.forwardingRules.html | 60 + docs/dyn/compute_v1.futureReservations.html | 48 + docs/dyn/compute_v1.globalAddresses.html | 48 + .../dyn/compute_v1.globalForwardingRules.html | 60 + ...ompute_v1.globalNetworkEndpointGroups.html | 48 + docs/dyn/compute_v1.globalOperations.html | 48 + ...mpute_v1.globalOrganizationOperations.html | 24 + ...pute_v1.globalPublicDelegatedPrefixes.html | 36 + docs/dyn/compute_v1.healthChecks.html | 48 + docs/dyn/compute_v1.html | 10 + docs/dyn/compute_v1.httpHealthChecks.html | 48 + docs/dyn/compute_v1.httpsHealthChecks.html | 48 + docs/dyn/compute_v1.images.html | 60 + ...v1.instanceGroupManagerResizeRequests.html | 36 + .../dyn/compute_v1.instanceGroupManagers.html | 1351 ++++++ docs/dyn/compute_v1.instanceGroups.html | 60 + docs/dyn/compute_v1.instanceSettings.html | 12 + docs/dyn/compute_v1.instanceTemplates.html | 24 + docs/dyn/compute_v1.instances.html | 462 +- docs/dyn/compute_v1.instantSnapshots.html | 36 + ...mpute_v1.interconnectAttachmentGroups.html | 36 + .../compute_v1.interconnectAttachments.html | 48 + docs/dyn/compute_v1.interconnectGroups.html | 48 + docs/dyn/compute_v1.interconnects.html | 48 + docs/dyn/compute_v1.licenses.html | 36 + docs/dyn/compute_v1.machineImages.html | 36 + docs/dyn/compute_v1.networkAttachments.html | 36 + ...ompute_v1.networkEdgeSecurityServices.html | 36 + .../dyn/compute_v1.networkEndpointGroups.html | 48 + .../compute_v1.networkFirewallPolicies.html | 144 + docs/dyn/compute_v1.networks.html | 96 + docs/dyn/compute_v1.nodeGroups.html | 96 + docs/dyn/compute_v1.nodeTemplates.html | 24 + ...mpute_v1.organizationSecurityPolicies.html | 120 + docs/dyn/compute_v1.packetMirrorings.html | 36 + docs/dyn/compute_v1.previewFeatures.html | 12 + docs/dyn/compute_v1.projects.html | 120 + .../compute_v1.publicAdvertisedPrefixes.html | 60 + .../compute_v1.publicDelegatedPrefixes.html | 60 + docs/dyn/compute_v1.regionAutoscalers.html | 48 + .../dyn/compute_v1.regionBackendServices.html | 72 +- docs/dyn/compute_v1.regionCommitments.html | 24 + ...ompute_v1.regionCompositeHealthChecks.html | 1613 +++++++ docs/dyn/compute_v1.regionDisks.html | 144 + ...te_v1.regionHealthAggregationPolicies.html | 36 + .../compute_v1.regionHealthCheckServices.html | 298 ++ docs/dyn/compute_v1.regionHealthChecks.html | 48 + docs/dyn/compute_v1.regionHealthSources.html | 1628 +++++++ ...ompute_v1.regionInstanceGroupManagers.html | 1124 +++++ docs/dyn/compute_v1.regionInstanceGroups.html | 12 + .../compute_v1.regionInstanceTemplates.html | 24 + docs/dyn/compute_v1.regionInstances.html | 12 + .../compute_v1.regionInstantSnapshots.html | 36 + ...ompute_v1.regionNetworkEndpointGroups.html | 48 + ...pute_v1.regionNetworkFirewallPolicies.html | 108 + ...ompute_v1.regionNotificationEndpoints.html | 281 ++ docs/dyn/compute_v1.regionOperations.html | 36 + .../compute_v1.regionSecurityPolicies.html | 84 + .../dyn/compute_v1.regionSslCertificates.html | 24 + docs/dyn/compute_v1.regionSslPolicies.html | 56 +- .../compute_v1.regionTargetHttpProxies.html | 36 + .../compute_v1.regionTargetHttpsProxies.html | 60 + .../compute_v1.regionTargetTcpProxies.html | 24 + docs/dyn/compute_v1.regionUrlMaps.html | 48 + docs/dyn/compute_v1.reservationBlocks.html | 12 + docs/dyn/compute_v1.reservationSlots.html | 320 ++ docs/dyn/compute_v1.reservationSubBlocks.html | 332 ++ docs/dyn/compute_v1.reservations.html | 60 + docs/dyn/compute_v1.resourcePolicies.html | 46 + docs/dyn/compute_v1.routers.html | 84 + docs/dyn/compute_v1.routes.html | 24 + docs/dyn/compute_v1.securityPolicies.html | 84 + docs/dyn/compute_v1.serviceAttachments.html | 46 + docs/dyn/compute_v1.snapshotSettings.html | 12 + docs/dyn/compute_v1.snapshots.html | 36 + docs/dyn/compute_v1.sslCertificates.html | 24 + docs/dyn/compute_v1.sslPolicies.html | 61 +- docs/dyn/compute_v1.storagePools.html | 36 + docs/dyn/compute_v1.subnetworks.html | 60 + docs/dyn/compute_v1.targetGrpcProxies.html | 36 + docs/dyn/compute_v1.targetHttpProxies.html | 48 + docs/dyn/compute_v1.targetHttpsProxies.html | 96 + docs/dyn/compute_v1.targetInstances.html | 36 + docs/dyn/compute_v1.targetPools.html | 96 + docs/dyn/compute_v1.targetSslProxies.html | 84 + docs/dyn/compute_v1.targetTcpProxies.html | 48 + docs/dyn/compute_v1.targetVpnGateways.html | 36 + docs/dyn/compute_v1.urlMaps.html | 60 + docs/dyn/compute_v1.vpnGateways.html | 36 + docs/dyn/compute_v1.vpnTunnels.html | 36 + docs/dyn/compute_v1.wireGroups.html | 36 + docs/dyn/compute_v1.zoneOperations.html | 36 + .../documents/compute.alpha.json | 243 +- .../documents/compute.beta.json | 1337 +++++- .../discovery_cache/documents/compute.v1.json | 4140 ++++++++++++++--- 249 files changed, 27788 insertions(+), 1039 deletions(-) create mode 100644 docs/dyn/compute_v1.regionCompositeHealthChecks.html create mode 100644 docs/dyn/compute_v1.regionHealthSources.html diff --git a/docs/dyn/compute_alpha.backendServices.html b/docs/dyn/compute_alpha.backendServices.html index b23e40f029..5040cc3f5a 100644 --- a/docs/dyn/compute_alpha.backendServices.html +++ b/docs/dyn/compute_alpha.backendServices.html @@ -1114,7 +1114,7 @@

Method Details

# draining traffic. A setting of false allows existing TCP # connections to persist, even on VMs no longer in the active pool, for up # to the duration of the connection draining timeout (10 minutes). - "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol isTCP. + "disableConnectionDrainOnFailover": True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. # # The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the @@ -3564,7 +3564,7 @@

Method Details

# draining traffic. A setting of false allows existing TCP # connections to persist, even on VMs no longer in the active pool, for up # to the duration of the connection draining timeout (10 minutes). - "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol isTCP. + "disableConnectionDrainOnFailover": True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. # # The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the @@ -4889,20 +4889,20 @@

Method Details

"ddosProtectionConfig": { "ddosAdaptiveProtection": "A String", "ddosImpactedBaselineThreshold": 3.14, # DDoS Protection for Network Load Balancers (and VMs with public IPs) - # builds DDos mitigations that minimize collateral damage. It quantifies + # builds DDoS mitigations that minimize collateral damage. It quantifies # this as the fraction of a non-abuse baseline that's inadvertently # blocked. # # Rules whose collateral damage exceeds ddosImpactedBaselineThreshold will # not be deployed. Using a lower value will prioritize keeping collateral # damage low, possibly at the cost of its effectiveness in rate limiting - # some or all of the attack. It should typically be unset, so Advanced DDos + # some or all of the attack. It should typically be unset, so Advanced DDoS # (and Adaptive Protection) uses the best mitigation it can find. Setting # the threshold is advised if there are logs for false positive detections - # with high collateral damage, and will cause Advanced DDos to attempt to - # find a less aggressive rule that satisfies the constraint; Failing that, - # it will fall back to no mitigation (smaller attack) or to broader network - # throttles (larger attack). + # with high collateral damage, and will cause Advanced DDoS to attempt to + # find a less aggressive rule that satisfies the constraint. If a suitable + # rule cannot be found, the system falls back to either no mitigation for + # smaller attacks or broader network throttles for larger ones. "ddosProtection": "A String", }, "description": "A String", # An optional description of this resource. Provide this property when you @@ -6536,7 +6536,7 @@

Method Details

# draining traffic. A setting of false allows existing TCP # connections to persist, even on VMs no longer in the active pool, for up # to the duration of the connection draining timeout (10 minutes). - "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol isTCP. + "disableConnectionDrainOnFailover": True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. # # The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the @@ -8684,7 +8684,7 @@

Method Details

# draining traffic. A setting of false allows existing TCP # connections to persist, even on VMs no longer in the active pool, for up # to the duration of the connection draining timeout (10 minutes). - "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol isTCP. + "disableConnectionDrainOnFailover": True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. # # The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the @@ -10580,7 +10580,7 @@

Method Details

# draining traffic. A setting of false allows existing TCP # connections to persist, even on VMs no longer in the active pool, for up # to the duration of the connection draining timeout (10 minutes). - "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol isTCP. + "disableConnectionDrainOnFailover": True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. # # The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the @@ -12419,7 +12419,7 @@

Method Details

# draining traffic. A setting of false allows existing TCP # connections to persist, even on VMs no longer in the active pool, for up # to the duration of the connection draining timeout (10 minutes). - "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol isTCP. + "disableConnectionDrainOnFailover": True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. # # The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the @@ -15989,7 +15989,7 @@

Method Details

# draining traffic. A setting of false allows existing TCP # connections to persist, even on VMs no longer in the active pool, for up # to the duration of the connection draining timeout (10 minutes). - "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol isTCP. + "disableConnectionDrainOnFailover": True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. # # The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the diff --git a/docs/dyn/compute_alpha.disks.html b/docs/dyn/compute_alpha.disks.html index 6bd0b18e96..e72d1c107d 100644 --- a/docs/dyn/compute_alpha.disks.html +++ b/docs/dyn/compute_alpha.disks.html @@ -147,7 +147,7 @@

Instance Methods

update(project, zone, disk, body=None, paths=None, requestId=None, updateMask=None, x__xgafv=None)

Updates the specified disk with the data included in the request.

- updateKmsKey(project, zone, disk, requestId=None, x__xgafv=None)

+ updateKmsKey(project, zone, disk, body=None, requestId=None, x__xgafv=None)

Rotates the customer-managed

waitForReplicationCatchUp(project, zone, disk, body=None, requestId=None, x__xgafv=None)

@@ -9561,7 +9561,7 @@

Method Details

- updateKmsKey(project, zone, disk, requestId=None, x__xgafv=None) + updateKmsKey(project, zone, disk, body=None, requestId=None, x__xgafv=None)
Rotates the customer-managed
 encryption key to the latest version for the specified persistent disk.
 
@@ -9569,6 +9569,24 @@ 

Method Details

project: string, Project ID for this request. (required) zone: string, The name of the zone for this request. (required) disk: string, Name of the Disk resource, should conform to RFC1035. (required) + body: object, The request body. + The object takes the form of: + +{ + "kmsKeyName": "A String", # Optional. The new KMS key to replace the current one on the disk. If empty, the disk + # will be re-encrypted using the primary version of the disk's current KMS + # key. + # + # The KMS key can be provided in the following formats: + # + # + # - projects/project_id/locations/location/keyRings/key_ring/cryptoKeys/key + # + # + # Where project is the project ID or + # project number. +} + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. diff --git a/docs/dyn/compute_alpha.futureReservations.html b/docs/dyn/compute_alpha.futureReservations.html index 18cd25c89d..39afeb4b54 100644 --- a/docs/dyn/compute_alpha.futureReservations.html +++ b/docs/dyn/compute_alpha.futureReservations.html @@ -315,6 +315,18 @@

Method Details

# delivery. The name prefix must comply with RFC1035. # Maximum allowed length for name prefix is 20. Automatically created # reservations name format will be -date-####. + "params": { # Additional future reservation params. # Input only. Additional params passed with the request, but not persisted + # as part of resource payload. + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the future reservation. Tag keys and + # values have the same definition as resource + # manager tags. Keys and values can be either in numeric format, + # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in + # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and + # `{tag_value_short_name}`. The field is ignored (both PUT & + # PATCH) when empty. + "a_key": "A String", + }, + }, "planningStatus": "A String", # Planning state before being submitted for evaluation "protectionTier": "A String", # Protection tier for the workload. "reservationMode": "A String", # The reservation mode which determines reservation-termination behavior and @@ -1337,6 +1349,18 @@

Method Details

# delivery. The name prefix must comply with RFC1035. # Maximum allowed length for name prefix is 20. Automatically created # reservations name format will be -date-####. + "params": { # Additional future reservation params. # Input only. Additional params passed with the request, but not persisted + # as part of resource payload. + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the future reservation. Tag keys and + # values have the same definition as resource + # manager tags. Keys and values can be either in numeric format, + # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in + # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and + # `{tag_value_short_name}`. The field is ignored (both PUT & + # PATCH) when empty. + "a_key": "A String", + }, + }, "planningStatus": "A String", # Planning state before being submitted for evaluation "protectionTier": "A String", # Protection tier for the workload. "reservationMode": "A String", # The reservation mode which determines reservation-termination behavior and @@ -1680,6 +1704,18 @@

Method Details

# delivery. The name prefix must comply with RFC1035. # Maximum allowed length for name prefix is 20. Automatically created # reservations name format will be -date-####. + "params": { # Additional future reservation params. # Input only. Additional params passed with the request, but not persisted + # as part of resource payload. + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the future reservation. Tag keys and + # values have the same definition as resource + # manager tags. Keys and values can be either in numeric format, + # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in + # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and + # `{tag_value_short_name}`. The field is ignored (both PUT & + # PATCH) when empty. + "a_key": "A String", + }, + }, "planningStatus": "A String", # Planning state before being submitted for evaluation "protectionTier": "A String", # Protection tier for the workload. "reservationMode": "A String", # The reservation mode which determines reservation-termination behavior and @@ -2402,6 +2438,18 @@

Method Details

# delivery. The name prefix must comply with RFC1035. # Maximum allowed length for name prefix is 20. Automatically created # reservations name format will be -date-####. + "params": { # Additional future reservation params. # Input only. Additional params passed with the request, but not persisted + # as part of resource payload. + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the future reservation. Tag keys and + # values have the same definition as resource + # manager tags. Keys and values can be either in numeric format, + # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in + # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and + # `{tag_value_short_name}`. The field is ignored (both PUT & + # PATCH) when empty. + "a_key": "A String", + }, + }, "planningStatus": "A String", # Planning state before being submitted for evaluation "protectionTier": "A String", # Protection tier for the workload. "reservationMode": "A String", # The reservation mode which determines reservation-termination behavior and @@ -2798,6 +2846,18 @@

Method Details

# delivery. The name prefix must comply with RFC1035. # Maximum allowed length for name prefix is 20. Automatically created # reservations name format will be -date-####. + "params": { # Additional future reservation params. # Input only. Additional params passed with the request, but not persisted + # as part of resource payload. + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the future reservation. Tag keys and + # values have the same definition as resource + # manager tags. Keys and values can be either in numeric format, + # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in + # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and + # `{tag_value_short_name}`. The field is ignored (both PUT & + # PATCH) when empty. + "a_key": "A String", + }, + }, "planningStatus": "A String", # Planning state before being submitted for evaluation "protectionTier": "A String", # Protection tier for the workload. "reservationMode": "A String", # The reservation mode which determines reservation-termination behavior and diff --git a/docs/dyn/compute_alpha.globalVmExtensionPolicies.html b/docs/dyn/compute_alpha.globalVmExtensionPolicies.html index ac80c01a40..8083bcdbe2 100644 --- a/docs/dyn/compute_alpha.globalVmExtensionPolicies.html +++ b/docs/dyn/compute_alpha.globalVmExtensionPolicies.html @@ -393,12 +393,14 @@

Method Details

# methods. # # A conflict occurs in the following cases: + # # * `insert` method: If the zonal policy already exists when the insert # happens. # * `update` method: If the zonal policy was modified by a zonal API call # outside of this rollout. # # Possible values are the following: + # # * `""` (empty string): If a conflict occurs, the local value is not # overwritten. This is the default behavior. # * `"overwrite"`: If a conflict occurs, the local value is overwritten @@ -406,7 +408,10 @@

Method Details

"name": "A String", # Optional. The name of the rollout plan. # Ex. # projects//locations/global/rolloutPlans/. - "predefinedRolloutPlan": "A String", # Optional. Predefined rollout plan. + "predefinedRolloutPlan": "A String", # Optional. Specifies the predefined rollout plan for the policy. Valid values + # are `SLOW_ROLLOUT` and `FAST_ROLLOUT`. The recommended value is + # `SLOW_ROLLOUT` for progressive rollout. For more information, see Rollout + # plans for global policies. "retryUuid": "A String", # Optional. The UUID that identifies a policy rollout retry attempt for update and # delete operations. Set this field only when retrying a rollout for an # existing extension policy. @@ -770,12 +775,14 @@

Method Details

# methods. # # A conflict occurs in the following cases: + # # * `insert` method: If the zonal policy already exists when the insert # happens. # * `update` method: If the zonal policy was modified by a zonal API call # outside of this rollout. # # Possible values are the following: + # # * `""` (empty string): If a conflict occurs, the local value is not # overwritten. This is the default behavior. # * `"overwrite"`: If a conflict occurs, the local value is overwritten @@ -783,7 +790,10 @@

Method Details

"name": "A String", # Optional. The name of the rollout plan. # Ex. # projects//locations/global/rolloutPlans/. - "predefinedRolloutPlan": "A String", # Optional. Predefined rollout plan. + "predefinedRolloutPlan": "A String", # Optional. Specifies the predefined rollout plan for the policy. Valid values + # are `SLOW_ROLLOUT` and `FAST_ROLLOUT`. The recommended value is + # `SLOW_ROLLOUT` for progressive rollout. For more information, see Rollout + # plans for global policies. "retryUuid": "A String", # Optional. The UUID that identifies a policy rollout retry attempt for update and # delete operations. Set this field only when retrying a rollout for an # existing extension policy. @@ -800,6 +810,12 @@

Method Details

# resource. There should be only one current rollout, but for # scalability, we make it repeated. { + "locationRolloutStatus": { # Output only. [Output Only] The rollout status for each location. The list of the + # locations is the same as the list of locations in the rollout plan. + "a_key": { + "state": "A String", # Output only. [Output Only] The state of the location rollout. + }, + }, "rollout": "A String", # Output only. [Output Only] The name of the rollout. # Ex. projects//locations/global/rollouts/. "rolloutPlan": "A String", # Output only. [Output Only] The name of the rollout plan. @@ -810,6 +826,12 @@

Method Details

], "previousRollout": { # Output only. [Output Only] The last completed rollout resource. This field will not # be populated until the first rollout is completed. + "locationRolloutStatus": { # Output only. [Output Only] The rollout status for each location. The list of the + # locations is the same as the list of locations in the rollout plan. + "a_key": { + "state": "A String", # Output only. [Output Only] The state of the location rollout. + }, + }, "rollout": "A String", # Output only. [Output Only] The name of the rollout. # Ex. projects//locations/global/rollouts/. "rolloutPlan": "A String", # Output only. [Output Only] The name of the rollout plan. @@ -910,12 +932,14 @@

Method Details

# methods. # # A conflict occurs in the following cases: + # # * `insert` method: If the zonal policy already exists when the insert # happens. # * `update` method: If the zonal policy was modified by a zonal API call # outside of this rollout. # # Possible values are the following: + # # * `""` (empty string): If a conflict occurs, the local value is not # overwritten. This is the default behavior. # * `"overwrite"`: If a conflict occurs, the local value is overwritten @@ -923,7 +947,10 @@

Method Details

"name": "A String", # Optional. The name of the rollout plan. # Ex. # projects//locations/global/rolloutPlans/. - "predefinedRolloutPlan": "A String", # Optional. Predefined rollout plan. + "predefinedRolloutPlan": "A String", # Optional. Specifies the predefined rollout plan for the policy. Valid values + # are `SLOW_ROLLOUT` and `FAST_ROLLOUT`. The recommended value is + # `SLOW_ROLLOUT` for progressive rollout. For more information, see Rollout + # plans for global policies. "retryUuid": "A String", # Optional. The UUID that identifies a policy rollout retry attempt for update and # delete operations. Set this field only when retrying a rollout for an # existing extension policy. @@ -940,6 +967,12 @@

Method Details

# resource. There should be only one current rollout, but for # scalability, we make it repeated. { + "locationRolloutStatus": { # Output only. [Output Only] The rollout status for each location. The list of the + # locations is the same as the list of locations in the rollout plan. + "a_key": { + "state": "A String", # Output only. [Output Only] The state of the location rollout. + }, + }, "rollout": "A String", # Output only. [Output Only] The name of the rollout. # Ex. projects//locations/global/rollouts/. "rolloutPlan": "A String", # Output only. [Output Only] The name of the rollout plan. @@ -950,6 +983,12 @@

Method Details

], "previousRollout": { # Output only. [Output Only] The last completed rollout resource. This field will not # be populated until the first rollout is completed. + "locationRolloutStatus": { # Output only. [Output Only] The rollout status for each location. The list of the + # locations is the same as the list of locations in the rollout plan. + "a_key": { + "state": "A String", # Output only. [Output Only] The state of the location rollout. + }, + }, "rollout": "A String", # Output only. [Output Only] The name of the rollout. # Ex. projects//locations/global/rollouts/. "rolloutPlan": "A String", # Output only. [Output Only] The name of the rollout plan. @@ -1404,12 +1443,14 @@

Method Details

# methods. # # A conflict occurs in the following cases: + # # * `insert` method: If the zonal policy already exists when the insert # happens. # * `update` method: If the zonal policy was modified by a zonal API call # outside of this rollout. # # Possible values are the following: + # # * `""` (empty string): If a conflict occurs, the local value is not # overwritten. This is the default behavior. # * `"overwrite"`: If a conflict occurs, the local value is overwritten @@ -1417,7 +1458,10 @@

Method Details

"name": "A String", # Optional. The name of the rollout plan. # Ex. # projects//locations/global/rolloutPlans/. - "predefinedRolloutPlan": "A String", # Optional. Predefined rollout plan. + "predefinedRolloutPlan": "A String", # Optional. Specifies the predefined rollout plan for the policy. Valid values + # are `SLOW_ROLLOUT` and `FAST_ROLLOUT`. The recommended value is + # `SLOW_ROLLOUT` for progressive rollout. For more information, see Rollout + # plans for global policies. "retryUuid": "A String", # Optional. The UUID that identifies a policy rollout retry attempt for update and # delete operations. Set this field only when retrying a rollout for an # existing extension policy. @@ -1434,6 +1478,12 @@

Method Details

# resource. There should be only one current rollout, but for # scalability, we make it repeated. { + "locationRolloutStatus": { # Output only. [Output Only] The rollout status for each location. The list of the + # locations is the same as the list of locations in the rollout plan. + "a_key": { + "state": "A String", # Output only. [Output Only] The state of the location rollout. + }, + }, "rollout": "A String", # Output only. [Output Only] The name of the rollout. # Ex. projects//locations/global/rollouts/. "rolloutPlan": "A String", # Output only. [Output Only] The name of the rollout plan. @@ -1444,6 +1494,12 @@

Method Details

], "previousRollout": { # Output only. [Output Only] The last completed rollout resource. This field will not # be populated until the first rollout is completed. + "locationRolloutStatus": { # Output only. [Output Only] The rollout status for each location. The list of the + # locations is the same as the list of locations in the rollout plan. + "a_key": { + "state": "A String", # Output only. [Output Only] The state of the location rollout. + }, + }, "rollout": "A String", # Output only. [Output Only] The name of the rollout. # Ex. projects//locations/global/rollouts/. "rolloutPlan": "A String", # Output only. [Output Only] The name of the rollout plan. @@ -1740,12 +1796,14 @@

Method Details

# methods. # # A conflict occurs in the following cases: + # # * `insert` method: If the zonal policy already exists when the insert # happens. # * `update` method: If the zonal policy was modified by a zonal API call # outside of this rollout. # # Possible values are the following: + # # * `""` (empty string): If a conflict occurs, the local value is not # overwritten. This is the default behavior. # * `"overwrite"`: If a conflict occurs, the local value is overwritten @@ -1753,7 +1811,10 @@

Method Details

"name": "A String", # Optional. The name of the rollout plan. # Ex. # projects//locations/global/rolloutPlans/. - "predefinedRolloutPlan": "A String", # Optional. Predefined rollout plan. + "predefinedRolloutPlan": "A String", # Optional. Specifies the predefined rollout plan for the policy. Valid values + # are `SLOW_ROLLOUT` and `FAST_ROLLOUT`. The recommended value is + # `SLOW_ROLLOUT` for progressive rollout. For more information, see Rollout + # plans for global policies. "retryUuid": "A String", # Optional. The UUID that identifies a policy rollout retry attempt for update and # delete operations. Set this field only when retrying a rollout for an # existing extension policy. @@ -1770,6 +1831,12 @@

Method Details

# resource. There should be only one current rollout, but for # scalability, we make it repeated. { + "locationRolloutStatus": { # Output only. [Output Only] The rollout status for each location. The list of the + # locations is the same as the list of locations in the rollout plan. + "a_key": { + "state": "A String", # Output only. [Output Only] The state of the location rollout. + }, + }, "rollout": "A String", # Output only. [Output Only] The name of the rollout. # Ex. projects//locations/global/rollouts/. "rolloutPlan": "A String", # Output only. [Output Only] The name of the rollout plan. @@ -1780,6 +1847,12 @@

Method Details

], "previousRollout": { # Output only. [Output Only] The last completed rollout resource. This field will not # be populated until the first rollout is completed. + "locationRolloutStatus": { # Output only. [Output Only] The rollout status for each location. The list of the + # locations is the same as the list of locations in the rollout plan. + "a_key": { + "state": "A String", # Output only. [Output Only] The state of the location rollout. + }, + }, "rollout": "A String", # Output only. [Output Only] The name of the rollout. # Ex. projects//locations/global/rollouts/. "rolloutPlan": "A String", # Output only. [Output Only] The name of the rollout plan. diff --git a/docs/dyn/compute_alpha.instanceGroupManagers.html b/docs/dyn/compute_alpha.instanceGroupManagers.html index 93fb5212b3..346cb10028 100644 --- a/docs/dyn/compute_alpha.instanceGroupManagers.html +++ b/docs/dyn/compute_alpha.instanceGroupManagers.html @@ -778,6 +778,11 @@

Method Details

# on resize events (depending on the value set inupdatePolicy.instanceRedistributionType). "zones": [ # Zones where the regional managed instance group will create and manage # its instances. + # By default, a regional MIG doesn't automatically select an AI zone to create + # instances, even if an AI zone is available in the specified region. To + # create instances in an AI zone in the selected region, you must explicitly + # specify it in the distribution policy together with the other preferred + # zones. { "zone": "A String", # The URL of thezone. # The zone must exist in the region where the managed instance group is @@ -4655,6 +4660,11 @@

Method Details

# on resize events (depending on the value set inupdatePolicy.instanceRedistributionType). "zones": [ # Zones where the regional managed instance group will create and manage # its instances. + # By default, a regional MIG doesn't automatically select an AI zone to create + # instances, even if an AI zone is available in the specified region. To + # create instances in an AI zone in the selected region, you must explicitly + # specify it in the distribution policy together with the other preferred + # zones. { "zone": "A String", # The URL of thezone. # The zone must exist in the region where the managed instance group is @@ -6647,6 +6657,11 @@

Method Details

# on resize events (depending on the value set inupdatePolicy.instanceRedistributionType). "zones": [ # Zones where the regional managed instance group will create and manage # its instances. + # By default, a regional MIG doesn't automatically select an AI zone to create + # instances, even if an AI zone is available in the specified region. To + # create instances in an AI zone in the selected region, you must explicitly + # specify it in the distribution policy together with the other preferred + # zones. { "zone": "A String", # The URL of thezone. # The zone must exist in the region where the managed instance group is @@ -8871,6 +8886,11 @@

Method Details

# on resize events (depending on the value set inupdatePolicy.instanceRedistributionType). "zones": [ # Zones where the regional managed instance group will create and manage # its instances. + # By default, a regional MIG doesn't automatically select an AI zone to create + # instances, even if an AI zone is available in the specified region. To + # create instances in an AI zone in the selected region, you must explicitly + # specify it in the distribution policy together with the other preferred + # zones. { "zone": "A String", # The URL of thezone. # The zone must exist in the region where the managed instance group is @@ -12571,6 +12591,11 @@

Method Details

# on resize events (depending on the value set inupdatePolicy.instanceRedistributionType). "zones": [ # Zones where the regional managed instance group will create and manage # its instances. + # By default, a regional MIG doesn't automatically select an AI zone to create + # instances, even if an AI zone is available in the specified region. To + # create instances in an AI zone in the selected region, you must explicitly + # specify it in the distribution policy together with the other preferred + # zones. { "zone": "A String", # The URL of thezone. # The zone must exist in the region where the managed instance group is @@ -18385,6 +18410,11 @@

Method Details

# on resize events (depending on the value set inupdatePolicy.instanceRedistributionType). "zones": [ # Zones where the regional managed instance group will create and manage # its instances. + # By default, a regional MIG doesn't automatically select an AI zone to create + # instances, even if an AI zone is available in the specified region. To + # create instances in an AI zone in the selected region, you must explicitly + # specify it in the distribution policy together with the other preferred + # zones. { "zone": "A String", # The URL of thezone. # The zone must exist in the region where the managed instance group is diff --git a/docs/dyn/compute_alpha.instanceTemplates.html b/docs/dyn/compute_alpha.instanceTemplates.html index aeb0fe6325..62dd7ec5f5 100644 --- a/docs/dyn/compute_alpha.instanceTemplates.html +++ b/docs/dyn/compute_alpha.instanceTemplates.html @@ -914,6 +914,17 @@

Method Details

# alias range. If not specified, the primary range of the subnetwork is used. }, ], + "aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. + # You can only specify this field for network interfaces in VPC networks. + { # An alias IP range attached to an instance's network interface. + "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range + # must belong to the specified subnetwork and cannot contain IP addresses + # reserved by system or used by other network interfaces. This range may be + # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24). + "subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP + # alias range. If not specified, the primary range of the subnetwork is used. + }, + ], "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid # with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. @@ -2452,6 +2463,17 @@

Method Details

# alias range. If not specified, the primary range of the subnetwork is used. }, ], + "aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. + # You can only specify this field for network interfaces in VPC networks. + { # An alias IP range attached to an instance's network interface. + "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range + # must belong to the specified subnetwork and cannot contain IP addresses + # reserved by system or used by other network interfaces. This range may be + # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24). + "subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP + # alias range. If not specified, the primary range of the subnetwork is used. + }, + ], "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid # with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. @@ -3975,6 +3997,17 @@

Method Details

# alias range. If not specified, the primary range of the subnetwork is used. }, ], + "aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. + # You can only specify this field for network interfaces in VPC networks. + { # An alias IP range attached to an instance's network interface. + "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range + # must belong to the specified subnetwork and cannot contain IP addresses + # reserved by system or used by other network interfaces. This range may be + # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24). + "subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP + # alias range. If not specified, the primary range of the subnetwork is used. + }, + ], "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid # with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. @@ -5508,6 +5541,17 @@

Method Details

# alias range. If not specified, the primary range of the subnetwork is used. }, ], + "aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. + # You can only specify this field for network interfaces in VPC networks. + { # An alias IP range attached to an instance's network interface. + "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range + # must belong to the specified subnetwork and cannot contain IP addresses + # reserved by system or used by other network interfaces. This range may be + # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24). + "subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP + # alias range. If not specified, the primary range of the subnetwork is used. + }, + ], "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid # with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. diff --git a/docs/dyn/compute_alpha.instances.html b/docs/dyn/compute_alpha.instances.html index 0d940aef1f..fc6b4a02e3 100644 --- a/docs/dyn/compute_alpha.instances.html +++ b/docs/dyn/compute_alpha.instances.html @@ -685,6 +685,17 @@

Method Details

# alias range. If not specified, the primary range of the subnetwork is used. }, ], + "aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. + # You can only specify this field for network interfaces in VPC networks. + { # An alias IP range attached to an instance's network interface. + "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range + # must belong to the specified subnetwork and cannot contain IP addresses + # reserved by system or used by other network interfaces. This range may be + # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24). + "subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP + # alias range. If not specified, the primary range of the subnetwork is used. + }, + ], "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid # with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. @@ -2314,6 +2325,17 @@

Method Details

# alias range. If not specified, the primary range of the subnetwork is used. }, ], + "aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. + # You can only specify this field for network interfaces in VPC networks. + { # An alias IP range attached to an instance's network interface. + "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range + # must belong to the specified subnetwork and cannot contain IP addresses + # reserved by system or used by other network interfaces. This range may be + # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24). + "subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP + # alias range. If not specified, the primary range of the subnetwork is used. + }, + ], "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid # with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. @@ -2655,6 +2677,7 @@

Method Details

# DEPRECATED: Use window_start_time instead. "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. # This timestamp value is in RFC3339 text format. + "maintenanceMethod": "A String", # Output only. Maintenance method for the upcoming maintenance. "maintenanceOnShutdown": True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown. "maintenanceReasons": [ # The reasons for the maintenance. Only valid for vms. "A String", @@ -2973,6 +2996,7 @@

Method Details

# DEPRECATED: Use window_start_time instead. "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. # This timestamp value is in RFC3339 text format. + "maintenanceMethod": "A String", # Output only. Maintenance method for the upcoming maintenance. "maintenanceOnShutdown": True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown. "maintenanceReasons": [ # The reasons for the maintenance. Only valid for vms. "A String", @@ -5060,6 +5084,17 @@

Method Details

# alias range. If not specified, the primary range of the subnetwork is used. }, ], + "aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. + # You can only specify this field for network interfaces in VPC networks. + { # An alias IP range attached to an instance's network interface. + "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range + # must belong to the specified subnetwork and cannot contain IP addresses + # reserved by system or used by other network interfaces. This range may be + # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24). + "subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP + # alias range. If not specified, the primary range of the subnetwork is used. + }, + ], "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid # with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. @@ -7817,6 +7852,17 @@

Method Details

# alias range. If not specified, the primary range of the subnetwork is used. }, ], + "aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. + # You can only specify this field for network interfaces in VPC networks. + { # An alias IP range attached to an instance's network interface. + "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range + # must belong to the specified subnetwork and cannot contain IP addresses + # reserved by system or used by other network interfaces. This range may be + # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24). + "subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP + # alias range. If not specified, the primary range of the subnetwork is used. + }, + ], "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid # with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. @@ -8158,6 +8204,7 @@

Method Details

# DEPRECATED: Use window_start_time instead. "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. # This timestamp value is in RFC3339 text format. + "maintenanceMethod": "A String", # Output only. Maintenance method for the upcoming maintenance. "maintenanceOnShutdown": True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown. "maintenanceReasons": [ # The reasons for the maintenance. Only valid for vms. "A String", @@ -8476,6 +8523,7 @@

Method Details

# DEPRECATED: Use window_start_time instead. "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. # This timestamp value is in RFC3339 text format. + "maintenanceMethod": "A String", # Output only. Maintenance method for the upcoming maintenance. "maintenanceOnShutdown": True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown. "maintenanceReasons": [ # The reasons for the maintenance. Only valid for vms. "A String", @@ -10999,6 +11047,17 @@

Method Details

# alias range. If not specified, the primary range of the subnetwork is used. }, ], + "aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. + # You can only specify this field for network interfaces in VPC networks. + { # An alias IP range attached to an instance's network interface. + "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range + # must belong to the specified subnetwork and cannot contain IP addresses + # reserved by system or used by other network interfaces. This range may be + # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24). + "subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP + # alias range. If not specified, the primary range of the subnetwork is used. + }, + ], "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid # with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. @@ -11340,6 +11399,7 @@

Method Details

# DEPRECATED: Use window_start_time instead. "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. # This timestamp value is in RFC3339 text format. + "maintenanceMethod": "A String", # Output only. Maintenance method for the upcoming maintenance. "maintenanceOnShutdown": True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown. "maintenanceReasons": [ # The reasons for the maintenance. Only valid for vms. "A String", @@ -11658,6 +11718,7 @@

Method Details

# DEPRECATED: Use window_start_time instead. "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. # This timestamp value is in RFC3339 text format. + "maintenanceMethod": "A String", # Output only. Maintenance method for the upcoming maintenance. "maintenanceOnShutdown": True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown. "maintenanceReasons": [ # The reasons for the maintenance. Only valid for vms. "A String", @@ -12873,6 +12934,17 @@

Method Details

# alias range. If not specified, the primary range of the subnetwork is used. }, ], + "aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. + # You can only specify this field for network interfaces in VPC networks. + { # An alias IP range attached to an instance's network interface. + "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range + # must belong to the specified subnetwork and cannot contain IP addresses + # reserved by system or used by other network interfaces. This range may be + # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24). + "subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP + # alias range. If not specified, the primary range of the subnetwork is used. + }, + ], "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid # with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. @@ -13214,6 +13286,7 @@

Method Details

# DEPRECATED: Use window_start_time instead. "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. # This timestamp value is in RFC3339 text format. + "maintenanceMethod": "A String", # Output only. Maintenance method for the upcoming maintenance. "maintenanceOnShutdown": True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown. "maintenanceReasons": [ # The reasons for the maintenance. Only valid for vms. "A String", @@ -13532,6 +13605,7 @@

Method Details

# DEPRECATED: Use window_start_time instead. "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. # This timestamp value is in RFC3339 text format. + "maintenanceMethod": "A String", # Output only. Maintenance method for the upcoming maintenance. "maintenanceOnShutdown": True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown. "maintenanceReasons": [ # The reasons for the maintenance. Only valid for vms. "A String", @@ -23682,6 +23756,17 @@

Method Details

# alias range. If not specified, the primary range of the subnetwork is used. }, ], + "aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. + # You can only specify this field for network interfaces in VPC networks. + { # An alias IP range attached to an instance's network interface. + "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range + # must belong to the specified subnetwork and cannot contain IP addresses + # reserved by system or used by other network interfaces. This range may be + # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24). + "subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP + # alias range. If not specified, the primary range of the subnetwork is used. + }, + ], "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid # with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. @@ -24023,6 +24108,7 @@

Method Details

# DEPRECATED: Use window_start_time instead. "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. # This timestamp value is in RFC3339 text format. + "maintenanceMethod": "A String", # Output only. Maintenance method for the upcoming maintenance. "maintenanceOnShutdown": True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown. "maintenanceReasons": [ # The reasons for the maintenance. Only valid for vms. "A String", @@ -24341,6 +24427,7 @@

Method Details

# DEPRECATED: Use window_start_time instead. "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. # This timestamp value is in RFC3339 text format. + "maintenanceMethod": "A String", # Output only. Maintenance method for the upcoming maintenance. "maintenanceOnShutdown": True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown. "maintenanceReasons": [ # The reasons for the maintenance. Only valid for vms. "A String", @@ -25415,6 +25502,17 @@

Method Details

# alias range. If not specified, the primary range of the subnetwork is used. }, ], + "aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. + # You can only specify this field for network interfaces in VPC networks. + { # An alias IP range attached to an instance's network interface. + "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range + # must belong to the specified subnetwork and cannot contain IP addresses + # reserved by system or used by other network interfaces. This range may be + # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24). + "subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP + # alias range. If not specified, the primary range of the subnetwork is used. + }, + ], "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid # with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. diff --git a/docs/dyn/compute_alpha.machineImages.html b/docs/dyn/compute_alpha.machineImages.html index fcfee24fc3..93a6ebde60 100644 --- a/docs/dyn/compute_alpha.machineImages.html +++ b/docs/dyn/compute_alpha.machineImages.html @@ -1092,6 +1092,17 @@

Method Details

# alias range. If not specified, the primary range of the subnetwork is used. }, ], + "aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. + # You can only specify this field for network interfaces in VPC networks. + { # An alias IP range attached to an instance's network interface. + "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range + # must belong to the specified subnetwork and cannot contain IP addresses + # reserved by system or used by other network interfaces. This range may be + # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24). + "subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP + # alias range. If not specified, the primary range of the subnetwork is used. + }, + ], "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid # with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. @@ -1938,6 +1949,17 @@

Method Details

# alias range. If not specified, the primary range of the subnetwork is used. }, ], + "aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. + # You can only specify this field for network interfaces in VPC networks. + { # An alias IP range attached to an instance's network interface. + "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range + # must belong to the specified subnetwork and cannot contain IP addresses + # reserved by system or used by other network interfaces. This range may be + # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24). + "subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP + # alias range. If not specified, the primary range of the subnetwork is used. + }, + ], "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid # with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. @@ -3329,6 +3351,17 @@

Method Details

# alias range. If not specified, the primary range of the subnetwork is used. }, ], + "aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. + # You can only specify this field for network interfaces in VPC networks. + { # An alias IP range attached to an instance's network interface. + "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range + # must belong to the specified subnetwork and cannot contain IP addresses + # reserved by system or used by other network interfaces. This range may be + # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24). + "subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP + # alias range. If not specified, the primary range of the subnetwork is used. + }, + ], "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid # with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. @@ -4175,6 +4208,17 @@

Method Details

# alias range. If not specified, the primary range of the subnetwork is used. }, ], + "aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. + # You can only specify this field for network interfaces in VPC networks. + { # An alias IP range attached to an instance's network interface. + "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range + # must belong to the specified subnetwork and cannot contain IP addresses + # reserved by system or used by other network interfaces. This range may be + # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24). + "subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP + # alias range. If not specified, the primary range of the subnetwork is used. + }, + ], "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid # with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. @@ -5572,6 +5616,17 @@

Method Details

# alias range. If not specified, the primary range of the subnetwork is used. }, ], + "aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. + # You can only specify this field for network interfaces in VPC networks. + { # An alias IP range attached to an instance's network interface. + "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range + # must belong to the specified subnetwork and cannot contain IP addresses + # reserved by system or used by other network interfaces. This range may be + # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24). + "subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP + # alias range. If not specified, the primary range of the subnetwork is used. + }, + ], "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid # with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. @@ -6418,6 +6473,17 @@

Method Details

# alias range. If not specified, the primary range of the subnetwork is used. }, ], + "aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. + # You can only specify this field for network interfaces in VPC networks. + { # An alias IP range attached to an instance's network interface. + "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range + # must belong to the specified subnetwork and cannot contain IP addresses + # reserved by system or used by other network interfaces. This range may be + # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24). + "subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP + # alias range. If not specified, the primary range of the subnetwork is used. + }, + ], "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid # with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. diff --git a/docs/dyn/compute_alpha.nodeGroups.html b/docs/dyn/compute_alpha.nodeGroups.html index 8cfa29e582..b4ff1895d1 100644 --- a/docs/dyn/compute_alpha.nodeGroups.html +++ b/docs/dyn/compute_alpha.nodeGroups.html @@ -2618,6 +2618,7 @@

Method Details

# DEPRECATED: Use window_start_time instead. "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. # This timestamp value is in RFC3339 text format. + "maintenanceMethod": "A String", # Output only. Maintenance method for the upcoming maintenance. "maintenanceOnShutdown": True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown. "maintenanceReasons": [ # The reasons for the maintenance. Only valid for vms. "A String", diff --git a/docs/dyn/compute_alpha.organizationSecurityPolicies.html b/docs/dyn/compute_alpha.organizationSecurityPolicies.html index 2fdaf9904d..2cac14b836 100644 --- a/docs/dyn/compute_alpha.organizationSecurityPolicies.html +++ b/docs/dyn/compute_alpha.organizationSecurityPolicies.html @@ -1964,20 +1964,20 @@

Method Details

"ddosProtectionConfig": { "ddosAdaptiveProtection": "A String", "ddosImpactedBaselineThreshold": 3.14, # DDoS Protection for Network Load Balancers (and VMs with public IPs) - # builds DDos mitigations that minimize collateral damage. It quantifies + # builds DDoS mitigations that minimize collateral damage. It quantifies # this as the fraction of a non-abuse baseline that's inadvertently # blocked. # # Rules whose collateral damage exceeds ddosImpactedBaselineThreshold will # not be deployed. Using a lower value will prioritize keeping collateral # damage low, possibly at the cost of its effectiveness in rate limiting - # some or all of the attack. It should typically be unset, so Advanced DDos + # some or all of the attack. It should typically be unset, so Advanced DDoS # (and Adaptive Protection) uses the best mitigation it can find. Setting # the threshold is advised if there are logs for false positive detections - # with high collateral damage, and will cause Advanced DDos to attempt to - # find a less aggressive rule that satisfies the constraint; Failing that, - # it will fall back to no mitigation (smaller attack) or to broader network - # throttles (larger attack). + # with high collateral damage, and will cause Advanced DDoS to attempt to + # find a less aggressive rule that satisfies the constraint. If a suitable + # rule cannot be found, the system falls back to either no mitigation for + # smaller attacks or broader network throttles for larger ones. "ddosProtection": "A String", }, "description": "A String", # An optional description of this resource. Provide this property when you @@ -3283,20 +3283,20 @@

Method Details

"ddosProtectionConfig": { "ddosAdaptiveProtection": "A String", "ddosImpactedBaselineThreshold": 3.14, # DDoS Protection for Network Load Balancers (and VMs with public IPs) - # builds DDos mitigations that minimize collateral damage. It quantifies + # builds DDoS mitigations that minimize collateral damage. It quantifies # this as the fraction of a non-abuse baseline that's inadvertently # blocked. # # Rules whose collateral damage exceeds ddosImpactedBaselineThreshold will # not be deployed. Using a lower value will prioritize keeping collateral # damage low, possibly at the cost of its effectiveness in rate limiting - # some or all of the attack. It should typically be unset, so Advanced DDos + # some or all of the attack. It should typically be unset, so Advanced DDoS # (and Adaptive Protection) uses the best mitigation it can find. Setting # the threshold is advised if there are logs for false positive detections - # with high collateral damage, and will cause Advanced DDos to attempt to - # find a less aggressive rule that satisfies the constraint; Failing that, - # it will fall back to no mitigation (smaller attack) or to broader network - # throttles (larger attack). + # with high collateral damage, and will cause Advanced DDoS to attempt to + # find a less aggressive rule that satisfies the constraint. If a suitable + # rule cannot be found, the system falls back to either no mitigation for + # smaller attacks or broader network throttles for larger ones. "ddosProtection": "A String", }, "description": "A String", # An optional description of this resource. Provide this property when you @@ -4428,20 +4428,20 @@

Method Details

"ddosProtectionConfig": { "ddosAdaptiveProtection": "A String", "ddosImpactedBaselineThreshold": 3.14, # DDoS Protection for Network Load Balancers (and VMs with public IPs) - # builds DDos mitigations that minimize collateral damage. It quantifies + # builds DDoS mitigations that minimize collateral damage. It quantifies # this as the fraction of a non-abuse baseline that's inadvertently # blocked. # # Rules whose collateral damage exceeds ddosImpactedBaselineThreshold will # not be deployed. Using a lower value will prioritize keeping collateral # damage low, possibly at the cost of its effectiveness in rate limiting - # some or all of the attack. It should typically be unset, so Advanced DDos + # some or all of the attack. It should typically be unset, so Advanced DDoS # (and Adaptive Protection) uses the best mitigation it can find. Setting # the threshold is advised if there are logs for false positive detections - # with high collateral damage, and will cause Advanced DDos to attempt to - # find a less aggressive rule that satisfies the constraint; Failing that, - # it will fall back to no mitigation (smaller attack) or to broader network - # throttles (larger attack). + # with high collateral damage, and will cause Advanced DDoS to attempt to + # find a less aggressive rule that satisfies the constraint. If a suitable + # rule cannot be found, the system falls back to either no mitigation for + # smaller attacks or broader network throttles for larger ones. "ddosProtection": "A String", }, "description": "A String", # An optional description of this resource. Provide this property when you @@ -5715,20 +5715,20 @@

Method Details

"ddosProtectionConfig": { "ddosAdaptiveProtection": "A String", "ddosImpactedBaselineThreshold": 3.14, # DDoS Protection for Network Load Balancers (and VMs with public IPs) - # builds DDos mitigations that minimize collateral damage. It quantifies + # builds DDoS mitigations that minimize collateral damage. It quantifies # this as the fraction of a non-abuse baseline that's inadvertently # blocked. # # Rules whose collateral damage exceeds ddosImpactedBaselineThreshold will # not be deployed. Using a lower value will prioritize keeping collateral # damage low, possibly at the cost of its effectiveness in rate limiting - # some or all of the attack. It should typically be unset, so Advanced DDos + # some or all of the attack. It should typically be unset, so Advanced DDoS # (and Adaptive Protection) uses the best mitigation it can find. Setting # the threshold is advised if there are logs for false positive detections - # with high collateral damage, and will cause Advanced DDos to attempt to - # find a less aggressive rule that satisfies the constraint; Failing that, - # it will fall back to no mitigation (smaller attack) or to broader network - # throttles (larger attack). + # with high collateral damage, and will cause Advanced DDoS to attempt to + # find a less aggressive rule that satisfies the constraint. If a suitable + # rule cannot be found, the system falls back to either no mitigation for + # smaller attacks or broader network throttles for larger ones. "ddosProtection": "A String", }, "description": "A String", # An optional description of this resource. Provide this property when you diff --git a/docs/dyn/compute_alpha.regionBackendServices.html b/docs/dyn/compute_alpha.regionBackendServices.html index 88ed7e2929..c42ef654e7 100644 --- a/docs/dyn/compute_alpha.regionBackendServices.html +++ b/docs/dyn/compute_alpha.regionBackendServices.html @@ -987,7 +987,7 @@

Method Details

# draining traffic. A setting of false allows existing TCP # connections to persist, even on VMs no longer in the active pool, for up # to the duration of the connection draining timeout (10 minutes). - "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol isTCP. + "disableConnectionDrainOnFailover": True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. # # The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the @@ -3186,7 +3186,7 @@

Method Details

# draining traffic. A setting of false allows existing TCP # connections to persist, even on VMs no longer in the active pool, for up # to the duration of the connection draining timeout (10 minutes). - "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol isTCP. + "disableConnectionDrainOnFailover": True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. # # The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the @@ -5335,7 +5335,7 @@

Method Details

# draining traffic. A setting of false allows existing TCP # connections to persist, even on VMs no longer in the active pool, for up # to the duration of the connection draining timeout (10 minutes). - "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol isTCP. + "disableConnectionDrainOnFailover": True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. # # The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the @@ -7234,7 +7234,7 @@

Method Details

# draining traffic. A setting of false allows existing TCP # connections to persist, even on VMs no longer in the active pool, for up # to the duration of the connection draining timeout (10 minutes). - "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol isTCP. + "disableConnectionDrainOnFailover": True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. # # The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the @@ -9074,7 +9074,7 @@

Method Details

# draining traffic. A setting of false allows existing TCP # connections to persist, even on VMs no longer in the active pool, for up # to the duration of the connection draining timeout (10 minutes). - "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol isTCP. + "disableConnectionDrainOnFailover": True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. # # The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the @@ -12348,7 +12348,7 @@

Method Details

# draining traffic. A setting of false allows existing TCP # connections to persist, even on VMs no longer in the active pool, for up # to the duration of the connection draining timeout (10 minutes). - "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol isTCP. + "disableConnectionDrainOnFailover": True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. # # The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the diff --git a/docs/dyn/compute_alpha.regionCommitments.html b/docs/dyn/compute_alpha.regionCommitments.html index dfe8c278b9..6b6adcaec1 100644 --- a/docs/dyn/compute_alpha.regionCommitments.html +++ b/docs/dyn/compute_alpha.regionCommitments.html @@ -279,6 +279,18 @@

Method Details

# character must be a lowercase letter, and all following characters must # be a dash, lowercase letter, or digit, except the last character, which # cannot be a dash. + "params": { # Additional commitment params. # Input only. Additional params passed with the request, but not persisted + # as part of resource payload. + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the commitment. Tag keys and + # values have the same definition as resource + # manager tags. Keys and values can be either in numeric format, + # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in + # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and + # `{tag_value_short_name}`. The field is ignored (both PUT & + # PATCH) when empty. + "a_key": "A String", + }, + }, "plan": "A String", # The minimum time duration that you commit to purchasing resources. # The plan that you choose determines the preset term length of the # commitment (which is 1 year or 3 years) and affects the discount rate that @@ -440,6 +452,7 @@

Method Details

# DEPRECATED: Use window_start_time instead. "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. # This timestamp value is in RFC3339 text format. + "maintenanceMethod": "A String", # Output only. Maintenance method for the upcoming maintenance. "maintenanceOnShutdown": True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown. "maintenanceReasons": [ # The reasons for the maintenance. Only valid for vms. "A String", @@ -1414,6 +1427,18 @@

Method Details

# character must be a lowercase letter, and all following characters must # be a dash, lowercase letter, or digit, except the last character, which # cannot be a dash. + "params": { # Additional commitment params. # Input only. Additional params passed with the request, but not persisted + # as part of resource payload. + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the commitment. Tag keys and + # values have the same definition as resource + # manager tags. Keys and values can be either in numeric format, + # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in + # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and + # `{tag_value_short_name}`. The field is ignored (both PUT & + # PATCH) when empty. + "a_key": "A String", + }, + }, "plan": "A String", # The minimum time duration that you commit to purchasing resources. # The plan that you choose determines the preset term length of the # commitment (which is 1 year or 3 years) and affects the discount rate that @@ -1575,6 +1600,7 @@

Method Details

# DEPRECATED: Use window_start_time instead. "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. # This timestamp value is in RFC3339 text format. + "maintenanceMethod": "A String", # Output only. Maintenance method for the upcoming maintenance. "maintenanceOnShutdown": True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown. "maintenanceReasons": [ # The reasons for the maintenance. Only valid for vms. "A String", @@ -1871,6 +1897,18 @@

Method Details

# character must be a lowercase letter, and all following characters must # be a dash, lowercase letter, or digit, except the last character, which # cannot be a dash. + "params": { # Additional commitment params. # Input only. Additional params passed with the request, but not persisted + # as part of resource payload. + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the commitment. Tag keys and + # values have the same definition as resource + # manager tags. Keys and values can be either in numeric format, + # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in + # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and + # `{tag_value_short_name}`. The field is ignored (both PUT & + # PATCH) when empty. + "a_key": "A String", + }, + }, "plan": "A String", # The minimum time duration that you commit to purchasing resources. # The plan that you choose determines the preset term length of the # commitment (which is 1 year or 3 years) and affects the discount rate that @@ -2032,6 +2070,7 @@

Method Details

# DEPRECATED: Use window_start_time instead. "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. # This timestamp value is in RFC3339 text format. + "maintenanceMethod": "A String", # Output only. Maintenance method for the upcoming maintenance. "maintenanceOnShutdown": True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown. "maintenanceReasons": [ # The reasons for the maintenance. Only valid for vms. "A String", @@ -2704,6 +2743,18 @@

Method Details

# character must be a lowercase letter, and all following characters must # be a dash, lowercase letter, or digit, except the last character, which # cannot be a dash. + "params": { # Additional commitment params. # Input only. Additional params passed with the request, but not persisted + # as part of resource payload. + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the commitment. Tag keys and + # values have the same definition as resource + # manager tags. Keys and values can be either in numeric format, + # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in + # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and + # `{tag_value_short_name}`. The field is ignored (both PUT & + # PATCH) when empty. + "a_key": "A String", + }, + }, "plan": "A String", # The minimum time duration that you commit to purchasing resources. # The plan that you choose determines the preset term length of the # commitment (which is 1 year or 3 years) and affects the discount rate that @@ -2865,6 +2916,7 @@

Method Details

# DEPRECATED: Use window_start_time instead. "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. # This timestamp value is in RFC3339 text format. + "maintenanceMethod": "A String", # Output only. Maintenance method for the upcoming maintenance. "maintenanceOnShutdown": True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown. "maintenanceReasons": [ # The reasons for the maintenance. Only valid for vms. "A String", @@ -3246,6 +3298,18 @@

Method Details

# character must be a lowercase letter, and all following characters must # be a dash, lowercase letter, or digit, except the last character, which # cannot be a dash. + "params": { # Additional commitment params. # Input only. Additional params passed with the request, but not persisted + # as part of resource payload. + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the commitment. Tag keys and + # values have the same definition as resource + # manager tags. Keys and values can be either in numeric format, + # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in + # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and + # `{tag_value_short_name}`. The field is ignored (both PUT & + # PATCH) when empty. + "a_key": "A String", + }, + }, "plan": "A String", # The minimum time duration that you commit to purchasing resources. # The plan that you choose determines the preset term length of the # commitment (which is 1 year or 3 years) and affects the discount rate that @@ -3407,6 +3471,7 @@

Method Details

# DEPRECATED: Use window_start_time instead. "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. # This timestamp value is in RFC3339 text format. + "maintenanceMethod": "A String", # Output only. Maintenance method for the upcoming maintenance. "maintenanceOnShutdown": True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown. "maintenanceReasons": [ # The reasons for the maintenance. Only valid for vms. "A String", @@ -4083,6 +4148,7 @@

Method Details

# DEPRECATED: Use window_start_time instead. "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. # This timestamp value is in RFC3339 text format. + "maintenanceMethod": "A String", # Output only. Maintenance method for the upcoming maintenance. "maintenanceOnShutdown": True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown. "maintenanceReasons": [ # The reasons for the maintenance. Only valid for vms. "A String", diff --git a/docs/dyn/compute_alpha.regionDisks.html b/docs/dyn/compute_alpha.regionDisks.html index 6dbd740b71..349298645d 100644 --- a/docs/dyn/compute_alpha.regionDisks.html +++ b/docs/dyn/compute_alpha.regionDisks.html @@ -135,7 +135,7 @@

Instance Methods

update(project, region, disk, body=None, paths=None, requestId=None, updateMask=None, x__xgafv=None)

Update the specified disk with the data included in the request. Update is

- updateKmsKey(project, region, disk, requestId=None, x__xgafv=None)

+ updateKmsKey(project, region, disk, body=None, requestId=None, x__xgafv=None)

Rotates the customer-managed

waitForReplicationCatchUp(project, region, disk, body=None, requestId=None, x__xgafv=None)

@@ -8116,7 +8116,7 @@

Method Details

- updateKmsKey(project, region, disk, requestId=None, x__xgafv=None) + updateKmsKey(project, region, disk, body=None, requestId=None, x__xgafv=None)
Rotates the customer-managed
 encryption key to the latest version for the specified persistent disk.
 
@@ -8124,6 +8124,24 @@ 

Method Details

project: string, Project ID for this request. (required) region: string, The name of the region for this request. (required) disk: string, Name of the Disk resource, should conform to RFC1035. (required) + body: object, The request body. + The object takes the form of: + +{ + "kmsKeyName": "A String", # Optional. The new KMS key to replace the current one on the disk. If empty, the disk + # will be re-encrypted using the primary version of the disk's current KMS + # key. + # + # The KMS key can be provided in the following formats: + # + # + # - projects/project_id/locations/location/keyRings/key_ring/cryptoKeys/key + # + # + # Where project is the project ID or + # project number. +} + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. diff --git a/docs/dyn/compute_alpha.regionInstanceGroupManagers.html b/docs/dyn/compute_alpha.regionInstanceGroupManagers.html index 044a19303c..a7d9a6e93f 100644 --- a/docs/dyn/compute_alpha.regionInstanceGroupManagers.html +++ b/docs/dyn/compute_alpha.regionInstanceGroupManagers.html @@ -2666,6 +2666,11 @@

Method Details

# on resize events (depending on the value set inupdatePolicy.instanceRedistributionType). "zones": [ # Zones where the regional managed instance group will create and manage # its instances. + # By default, a regional MIG doesn't automatically select an AI zone to create + # instances, even if an AI zone is available in the specified region. To + # create instances in an AI zone in the selected region, you must explicitly + # specify it in the distribution policy together with the other preferred + # zones. { "zone": "A String", # The URL of thezone. # The zone must exist in the region where the managed instance group is @@ -4520,6 +4525,11 @@

Method Details

# on resize events (depending on the value set inupdatePolicy.instanceRedistributionType). "zones": [ # Zones where the regional managed instance group will create and manage # its instances. + # By default, a regional MIG doesn't automatically select an AI zone to create + # instances, even if an AI zone is available in the specified region. To + # create instances in an AI zone in the selected region, you must explicitly + # specify it in the distribution policy together with the other preferred + # zones. { "zone": "A String", # The URL of thezone. # The zone must exist in the region where the managed instance group is @@ -6743,6 +6753,11 @@

Method Details

# on resize events (depending on the value set inupdatePolicy.instanceRedistributionType). "zones": [ # Zones where the regional managed instance group will create and manage # its instances. + # By default, a regional MIG doesn't automatically select an AI zone to create + # instances, even if an AI zone is available in the specified region. To + # create instances in an AI zone in the selected region, you must explicitly + # specify it in the distribution policy together with the other preferred + # zones. { "zone": "A String", # The URL of thezone. # The zone must exist in the region where the managed instance group is @@ -10435,6 +10450,11 @@

Method Details

# on resize events (depending on the value set inupdatePolicy.instanceRedistributionType). "zones": [ # Zones where the regional managed instance group will create and manage # its instances. + # By default, a regional MIG doesn't automatically select an AI zone to create + # instances, even if an AI zone is available in the specified region. To + # create instances in an AI zone in the selected region, you must explicitly + # specify it in the distribution policy together with the other preferred + # zones. { "zone": "A String", # The URL of thezone. # The zone must exist in the region where the managed instance group is @@ -16215,6 +16235,11 @@

Method Details

# on resize events (depending on the value set inupdatePolicy.instanceRedistributionType). "zones": [ # Zones where the regional managed instance group will create and manage # its instances. + # By default, a regional MIG doesn't automatically select an AI zone to create + # instances, even if an AI zone is available in the specified region. To + # create instances in an AI zone in the selected region, you must explicitly + # specify it in the distribution policy together with the other preferred + # zones. { "zone": "A String", # The URL of thezone. # The zone must exist in the region where the managed instance group is diff --git a/docs/dyn/compute_alpha.regionInstanceTemplates.html b/docs/dyn/compute_alpha.regionInstanceTemplates.html index 6659d635a2..93ed9ff677 100644 --- a/docs/dyn/compute_alpha.regionInstanceTemplates.html +++ b/docs/dyn/compute_alpha.regionInstanceTemplates.html @@ -1104,6 +1104,17 @@

Method Details

# alias range. If not specified, the primary range of the subnetwork is used. }, ], + "aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. + # You can only specify this field for network interfaces in VPC networks. + { # An alias IP range attached to an instance's network interface. + "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range + # must belong to the specified subnetwork and cannot contain IP addresses + # reserved by system or used by other network interfaces. This range may be + # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24). + "subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP + # alias range. If not specified, the primary range of the subnetwork is used. + }, + ], "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid # with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. @@ -2257,6 +2268,17 @@

Method Details

# alias range. If not specified, the primary range of the subnetwork is used. }, ], + "aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. + # You can only specify this field for network interfaces in VPC networks. + { # An alias IP range attached to an instance's network interface. + "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range + # must belong to the specified subnetwork and cannot contain IP addresses + # reserved by system or used by other network interfaces. This range may be + # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24). + "subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP + # alias range. If not specified, the primary range of the subnetwork is used. + }, + ], "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid # with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. @@ -3791,6 +3813,17 @@

Method Details

# alias range. If not specified, the primary range of the subnetwork is used. }, ], + "aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. + # You can only specify this field for network interfaces in VPC networks. + { # An alias IP range attached to an instance's network interface. + "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range + # must belong to the specified subnetwork and cannot contain IP addresses + # reserved by system or used by other network interfaces. This range may be + # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24). + "subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP + # alias range. If not specified, the primary range of the subnetwork is used. + }, + ], "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid # with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. diff --git a/docs/dyn/compute_alpha.regionInstances.html b/docs/dyn/compute_alpha.regionInstances.html index 4f30e57285..c3d739e4a0 100644 --- a/docs/dyn/compute_alpha.regionInstances.html +++ b/docs/dyn/compute_alpha.regionInstances.html @@ -1270,6 +1270,17 @@

Method Details

# alias range. If not specified, the primary range of the subnetwork is used. }, ], + "aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. + # You can only specify this field for network interfaces in VPC networks. + { # An alias IP range attached to an instance's network interface. + "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range + # must belong to the specified subnetwork and cannot contain IP addresses + # reserved by system or used by other network interfaces. This range may be + # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24). + "subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP + # alias range. If not specified, the primary range of the subnetwork is used. + }, + ], "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid # with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. diff --git a/docs/dyn/compute_alpha.regionSecurityPolicies.html b/docs/dyn/compute_alpha.regionSecurityPolicies.html index 518c3eba1d..0085b6c210 100644 --- a/docs/dyn/compute_alpha.regionSecurityPolicies.html +++ b/docs/dyn/compute_alpha.regionSecurityPolicies.html @@ -1309,20 +1309,20 @@

Method Details

"ddosProtectionConfig": { "ddosAdaptiveProtection": "A String", "ddosImpactedBaselineThreshold": 3.14, # DDoS Protection for Network Load Balancers (and VMs with public IPs) - # builds DDos mitigations that minimize collateral damage. It quantifies + # builds DDoS mitigations that minimize collateral damage. It quantifies # this as the fraction of a non-abuse baseline that's inadvertently # blocked. # # Rules whose collateral damage exceeds ddosImpactedBaselineThreshold will # not be deployed. Using a lower value will prioritize keeping collateral # damage low, possibly at the cost of its effectiveness in rate limiting - # some or all of the attack. It should typically be unset, so Advanced DDos + # some or all of the attack. It should typically be unset, so Advanced DDoS # (and Adaptive Protection) uses the best mitigation it can find. Setting # the threshold is advised if there are logs for false positive detections - # with high collateral damage, and will cause Advanced DDos to attempt to - # find a less aggressive rule that satisfies the constraint; Failing that, - # it will fall back to no mitigation (smaller attack) or to broader network - # throttles (larger attack). + # with high collateral damage, and will cause Advanced DDoS to attempt to + # find a less aggressive rule that satisfies the constraint. If a suitable + # rule cannot be found, the system falls back to either no mitigation for + # smaller attacks or broader network throttles for larger ones. "ddosProtection": "A String", }, "description": "A String", # An optional description of this resource. Provide this property when you @@ -2589,20 +2589,20 @@

Method Details

"ddosProtectionConfig": { "ddosAdaptiveProtection": "A String", "ddosImpactedBaselineThreshold": 3.14, # DDoS Protection for Network Load Balancers (and VMs with public IPs) - # builds DDos mitigations that minimize collateral damage. It quantifies + # builds DDoS mitigations that minimize collateral damage. It quantifies # this as the fraction of a non-abuse baseline that's inadvertently # blocked. # # Rules whose collateral damage exceeds ddosImpactedBaselineThreshold will # not be deployed. Using a lower value will prioritize keeping collateral # damage low, possibly at the cost of its effectiveness in rate limiting - # some or all of the attack. It should typically be unset, so Advanced DDos + # some or all of the attack. It should typically be unset, so Advanced DDoS # (and Adaptive Protection) uses the best mitigation it can find. Setting # the threshold is advised if there are logs for false positive detections - # with high collateral damage, and will cause Advanced DDos to attempt to - # find a less aggressive rule that satisfies the constraint; Failing that, - # it will fall back to no mitigation (smaller attack) or to broader network - # throttles (larger attack). + # with high collateral damage, and will cause Advanced DDoS to attempt to + # find a less aggressive rule that satisfies the constraint. If a suitable + # rule cannot be found, the system falls back to either no mitigation for + # smaller attacks or broader network throttles for larger ones. "ddosProtection": "A String", }, "description": "A String", # An optional description of this resource. Provide this property when you @@ -3729,20 +3729,20 @@

Method Details

"ddosProtectionConfig": { "ddosAdaptiveProtection": "A String", "ddosImpactedBaselineThreshold": 3.14, # DDoS Protection for Network Load Balancers (and VMs with public IPs) - # builds DDos mitigations that minimize collateral damage. It quantifies + # builds DDoS mitigations that minimize collateral damage. It quantifies # this as the fraction of a non-abuse baseline that's inadvertently # blocked. # # Rules whose collateral damage exceeds ddosImpactedBaselineThreshold will # not be deployed. Using a lower value will prioritize keeping collateral # damage low, possibly at the cost of its effectiveness in rate limiting - # some or all of the attack. It should typically be unset, so Advanced DDos + # some or all of the attack. It should typically be unset, so Advanced DDoS # (and Adaptive Protection) uses the best mitigation it can find. Setting # the threshold is advised if there are logs for false positive detections - # with high collateral damage, and will cause Advanced DDos to attempt to - # find a less aggressive rule that satisfies the constraint; Failing that, - # it will fall back to no mitigation (smaller attack) or to broader network - # throttles (larger attack). + # with high collateral damage, and will cause Advanced DDoS to attempt to + # find a less aggressive rule that satisfies the constraint. If a suitable + # rule cannot be found, the system falls back to either no mitigation for + # smaller attacks or broader network throttles for larger ones. "ddosProtection": "A String", }, "description": "A String", # An optional description of this resource. Provide this property when you @@ -4545,20 +4545,20 @@

Method Details

"ddosProtectionConfig": { "ddosAdaptiveProtection": "A String", "ddosImpactedBaselineThreshold": 3.14, # DDoS Protection for Network Load Balancers (and VMs with public IPs) - # builds DDos mitigations that minimize collateral damage. It quantifies + # builds DDoS mitigations that minimize collateral damage. It quantifies # this as the fraction of a non-abuse baseline that's inadvertently # blocked. # # Rules whose collateral damage exceeds ddosImpactedBaselineThreshold will # not be deployed. Using a lower value will prioritize keeping collateral # damage low, possibly at the cost of its effectiveness in rate limiting - # some or all of the attack. It should typically be unset, so Advanced DDos + # some or all of the attack. It should typically be unset, so Advanced DDoS # (and Adaptive Protection) uses the best mitigation it can find. Setting # the threshold is advised if there are logs for false positive detections - # with high collateral damage, and will cause Advanced DDos to attempt to - # find a less aggressive rule that satisfies the constraint; Failing that, - # it will fall back to no mitigation (smaller attack) or to broader network - # throttles (larger attack). + # with high collateral damage, and will cause Advanced DDoS to attempt to + # find a less aggressive rule that satisfies the constraint. If a suitable + # rule cannot be found, the system falls back to either no mitigation for + # smaller attacks or broader network throttles for larger ones. "ddosProtection": "A String", }, "description": "A String", # An optional description of this resource. Provide this property when you diff --git a/docs/dyn/compute_alpha.regionSnapshots.html b/docs/dyn/compute_alpha.regionSnapshots.html index b79a8a28c4..8156777339 100644 --- a/docs/dyn/compute_alpha.regionSnapshots.html +++ b/docs/dyn/compute_alpha.regionSnapshots.html @@ -105,7 +105,7 @@

Instance Methods

testIamPermissions(project, region, resource, body=None, x__xgafv=None)

Returns permissions that a caller has on the specified resource.

- updateKmsKey(project, region, snapshot, requestId=None, x__xgafv=None)

+ updateKmsKey(project, region, snapshot, body=None, requestId=None, x__xgafv=None)

Rotates the customer-managed

Method Details

@@ -3453,7 +3453,7 @@

Method Details

- updateKmsKey(project, region, snapshot, requestId=None, x__xgafv=None) + updateKmsKey(project, region, snapshot, body=None, requestId=None, x__xgafv=None)
Rotates the customer-managed
 encryption key to the latest version for the specified snapshot.
 
@@ -3461,6 +3461,20 @@ 

Method Details

project: string, Project ID for this request. (required) region: string, Name of the region for this request. (required) snapshot: string, Name of the snapshot resource to update. Should conform to RFC1035. (required) + body: object, The request body. + The object takes the form of: + +{ + "kmsKeyName": "A String", # Optional. The new KMS key to replace the current one on the snapshot. If empty, the + # snapshot will be re-encrypted using the primary version of the snapshot's + # current KMS key. + # + # The KMS key can be provided in the following formats: + # + # + # - projects/project_id/locations/region/keyRings/region/cryptoKeys/key +} + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. diff --git a/docs/dyn/compute_alpha.regionSslPolicies.html b/docs/dyn/compute_alpha.regionSslPolicies.html index af4f43258c..b80c3465a8 100644 --- a/docs/dyn/compute_alpha.regionSslPolicies.html +++ b/docs/dyn/compute_alpha.regionSslPolicies.html @@ -464,12 +464,14 @@

Method Details

# negotiating X25519MLKEM768 key exchange when clients advertise support for # it. When set to DEFAULT, or if no SSL Policy is # attached to the target proxy, the load balancer disallows X25519MLKEM768 - # key exchange until it is enabled by default on LBs. When set toENABLED, the load balancer will negotiate X25519MLKEM768 key - # exchange. Customers can set this to DEFERRED to temporarily - # opt-out the LB from negotiating post-quantum key exchange by default. + # key exchange until it is enabled by default on load balancers. When set toENABLED, the load balancer can negotiate X25519MLKEM768 key + # exchange. When set to DEFERRED, temporarily opts out the load + # balancer from negotiating X25519MLKEM768 beyond the point where it is + # enabled by default on load balancers. "profile": "A String", # Profile specifies the set of SSL features that can be used by the load - # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features - # to enable must be specified in the customFeatures field. + # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED,FIPS_202205, or CUSTOM. If usingCUSTOM, the set of SSL features to enable must be specified in + # the customFeatures field. If using FIPS_202205, + # the min_tls_version field must be set to TLS_1_2. "region": "A String", # Output only. [Output Only] URL of the region where the regional SSL policy # resides. This field is not applicable to global SSL policies. "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. @@ -671,12 +673,14 @@

Method Details

# negotiating X25519MLKEM768 key exchange when clients advertise support for # it. When set to DEFAULT, or if no SSL Policy is # attached to the target proxy, the load balancer disallows X25519MLKEM768 - # key exchange until it is enabled by default on LBs. When set toENABLED, the load balancer will negotiate X25519MLKEM768 key - # exchange. Customers can set this to DEFERRED to temporarily - # opt-out the LB from negotiating post-quantum key exchange by default. + # key exchange until it is enabled by default on load balancers. When set toENABLED, the load balancer can negotiate X25519MLKEM768 key + # exchange. When set to DEFERRED, temporarily opts out the load + # balancer from negotiating X25519MLKEM768 beyond the point where it is + # enabled by default on load balancers. "profile": "A String", # Profile specifies the set of SSL features that can be used by the load - # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features - # to enable must be specified in the customFeatures field. + # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED,FIPS_202205, or CUSTOM. If usingCUSTOM, the set of SSL features to enable must be specified in + # the customFeatures field. If using FIPS_202205, + # the min_tls_version field must be set to TLS_1_2. "region": "A String", # Output only. [Output Only] URL of the region where the regional SSL policy # resides. This field is not applicable to global SSL policies. "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. @@ -1254,12 +1258,14 @@

Method Details

# negotiating X25519MLKEM768 key exchange when clients advertise support for # it. When set to DEFAULT, or if no SSL Policy is # attached to the target proxy, the load balancer disallows X25519MLKEM768 - # key exchange until it is enabled by default on LBs. When set toENABLED, the load balancer will negotiate X25519MLKEM768 key - # exchange. Customers can set this to DEFERRED to temporarily - # opt-out the LB from negotiating post-quantum key exchange by default. + # key exchange until it is enabled by default on load balancers. When set toENABLED, the load balancer can negotiate X25519MLKEM768 key + # exchange. When set to DEFERRED, temporarily opts out the load + # balancer from negotiating X25519MLKEM768 beyond the point where it is + # enabled by default on load balancers. "profile": "A String", # Profile specifies the set of SSL features that can be used by the load - # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features - # to enable must be specified in the customFeatures field. + # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED,FIPS_202205, or CUSTOM. If usingCUSTOM, the set of SSL features to enable must be specified in + # the customFeatures field. If using FIPS_202205, + # the min_tls_version field must be set to TLS_1_2. "region": "A String", # Output only. [Output Only] URL of the region where the regional SSL policy # resides. This field is not applicable to global SSL policies. "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. @@ -1616,12 +1622,14 @@

Method Details

# negotiating X25519MLKEM768 key exchange when clients advertise support for # it. When set to DEFAULT, or if no SSL Policy is # attached to the target proxy, the load balancer disallows X25519MLKEM768 - # key exchange until it is enabled by default on LBs. When set toENABLED, the load balancer will negotiate X25519MLKEM768 key - # exchange. Customers can set this to DEFERRED to temporarily - # opt-out the LB from negotiating post-quantum key exchange by default. + # key exchange until it is enabled by default on load balancers. When set toENABLED, the load balancer can negotiate X25519MLKEM768 key + # exchange. When set to DEFERRED, temporarily opts out the load + # balancer from negotiating X25519MLKEM768 beyond the point where it is + # enabled by default on load balancers. "profile": "A String", # Profile specifies the set of SSL features that can be used by the load - # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features - # to enable must be specified in the customFeatures field. + # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED,FIPS_202205, or CUSTOM. If usingCUSTOM, the set of SSL features to enable must be specified in + # the customFeatures field. If using FIPS_202205, + # the min_tls_version field must be set to TLS_1_2. "region": "A String", # Output only. [Output Only] URL of the region where the regional SSL policy # resides. This field is not applicable to global SSL policies. "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. diff --git a/docs/dyn/compute_alpha.regionUrlMaps.html b/docs/dyn/compute_alpha.regionUrlMaps.html index a38684e6db..60f438b40c 100644 --- a/docs/dyn/compute_alpha.regionUrlMaps.html +++ b/docs/dyn/compute_alpha.regionUrlMaps.html @@ -860,6 +860,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -1697,6 +1708,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -2515,6 +2537,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -3595,6 +3628,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -4432,6 +4476,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -5269,6 +5324,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -6087,6 +6153,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -7167,6 +7244,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -8690,6 +8778,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -9527,6 +9626,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -10345,6 +10455,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -11425,6 +11546,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -12313,6 +12445,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -13150,6 +13293,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -13968,6 +14122,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -15048,6 +15213,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -16194,6 +16370,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -17031,6 +17218,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -17849,6 +18047,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -18929,6 +19138,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -20043,6 +20263,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -20880,6 +21111,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -21698,6 +21940,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -22778,6 +23031,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), diff --git a/docs/dyn/compute_alpha.reservationBlocks.html b/docs/dyn/compute_alpha.reservationBlocks.html index 2d7be0bc4d..1ffc59735f 100644 --- a/docs/dyn/compute_alpha.reservationBlocks.html +++ b/docs/dyn/compute_alpha.reservationBlocks.html @@ -181,6 +181,7 @@

Method Details

# DEPRECATED: Use window_start_time instead. "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. # This timestamp value is in RFC3339 text format. + "maintenanceMethod": "A String", # Output only. Maintenance method for the upcoming maintenance. "maintenanceOnShutdown": True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown. "maintenanceReasons": [ # The reasons for the maintenance. Only valid for vms. "A String", @@ -381,6 +382,7 @@

Method Details

# DEPRECATED: Use window_start_time instead. "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. # This timestamp value is in RFC3339 text format. + "maintenanceMethod": "A String", # Output only. Maintenance method for the upcoming maintenance. "maintenanceOnShutdown": True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown. "maintenanceReasons": [ # The reasons for the maintenance. Only valid for vms. "A String", diff --git a/docs/dyn/compute_alpha.reservationSubBlocks.html b/docs/dyn/compute_alpha.reservationSubBlocks.html index ef18e3ae3f..fb8423911c 100644 --- a/docs/dyn/compute_alpha.reservationSubBlocks.html +++ b/docs/dyn/compute_alpha.reservationSubBlocks.html @@ -191,6 +191,7 @@

Method Details

# DEPRECATED: Use window_start_time instead. "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. # This timestamp value is in RFC3339 text format. + "maintenanceMethod": "A String", # Output only. Maintenance method for the upcoming maintenance. "maintenanceOnShutdown": True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown. "maintenanceReasons": [ # The reasons for the maintenance. Only valid for vms. "A String", @@ -696,6 +697,7 @@

Method Details

# DEPRECATED: Use window_start_time instead. "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. # This timestamp value is in RFC3339 text format. + "maintenanceMethod": "A String", # Output only. Maintenance method for the upcoming maintenance. "maintenanceOnShutdown": True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown. "maintenanceReasons": [ # The reasons for the maintenance. Only valid for vms. "A String", diff --git a/docs/dyn/compute_alpha.reservations.html b/docs/dyn/compute_alpha.reservations.html index 63ebfdac46..f1843dc454 100644 --- a/docs/dyn/compute_alpha.reservations.html +++ b/docs/dyn/compute_alpha.reservations.html @@ -375,6 +375,7 @@

Method Details

# DEPRECATED: Use window_start_time instead. "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. # This timestamp value is in RFC3339 text format. + "maintenanceMethod": "A String", # Output only. Maintenance method for the upcoming maintenance. "maintenanceOnShutdown": True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown. "maintenanceReasons": [ # The reasons for the maintenance. Only valid for vms. "A String", @@ -1044,6 +1045,7 @@

Method Details

# DEPRECATED: Use window_start_time instead. "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. # This timestamp value is in RFC3339 text format. + "maintenanceMethod": "A String", # Output only. Maintenance method for the upcoming maintenance. "maintenanceOnShutdown": True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown. "maintenanceReasons": [ # The reasons for the maintenance. Only valid for vms. "A String", @@ -1699,6 +1701,7 @@

Method Details

# DEPRECATED: Use window_start_time instead. "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. # This timestamp value is in RFC3339 text format. + "maintenanceMethod": "A String", # Output only. Maintenance method for the upcoming maintenance. "maintenanceOnShutdown": True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown. "maintenanceReasons": [ # The reasons for the maintenance. Only valid for vms. "A String", @@ -2362,6 +2365,7 @@

Method Details

# DEPRECATED: Use window_start_time instead. "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. # This timestamp value is in RFC3339 text format. + "maintenanceMethod": "A String", # Output only. Maintenance method for the upcoming maintenance. "maintenanceOnShutdown": True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown. "maintenanceReasons": [ # The reasons for the maintenance. Only valid for vms. "A String", @@ -4212,6 +4216,7 @@

Method Details

# DEPRECATED: Use window_start_time instead. "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. # This timestamp value is in RFC3339 text format. + "maintenanceMethod": "A String", # Output only. Maintenance method for the upcoming maintenance. "maintenanceOnShutdown": True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown. "maintenanceReasons": [ # The reasons for the maintenance. Only valid for vms. "A String", diff --git a/docs/dyn/compute_alpha.rollouts.html b/docs/dyn/compute_alpha.rollouts.html index 5f065725f3..5bb71104f9 100644 --- a/docs/dyn/compute_alpha.rollouts.html +++ b/docs/dyn/compute_alpha.rollouts.html @@ -770,6 +770,8 @@

Method Details

# Integration model. # model. "completedResourcesCount": "A String", # Output only. Resource completed so far. + "estimatedCompletionTime": "A String", # Output only. Estimated timestamp at which the wave will complete. Extrapolated from + # current progress. "estimatedTotalResourcesCount": "A String", # Output only. Estimated total count of resources. "failedLocations": [ # Output only. Locations that failed during orchestration, and ProgressiveRollout # stopped retrying. There may be some successful resources rolled out in @@ -777,6 +779,12 @@

Method Details

"A String", ], "failedResourcesCount": "A String", # Output only. Resources failed. + "locationStatus": { # Output only. Status of each location in the wave. Map keys (locations) must be + # specified like "us-east1" or "asia-west1-a". + "a_key": { # Represents the status of a location in a wave. + "state": "A String", # Output only. Location state of the wave. + }, + }, }, "waveDisplayName": "A String", # Output only. Wave name. # Ex. wave1 @@ -948,6 +956,8 @@

Method Details

# Integration model. # model. "completedResourcesCount": "A String", # Output only. Resource completed so far. + "estimatedCompletionTime": "A String", # Output only. Estimated timestamp at which the wave will complete. Extrapolated from + # current progress. "estimatedTotalResourcesCount": "A String", # Output only. Estimated total count of resources. "failedLocations": [ # Output only. Locations that failed during orchestration, and ProgressiveRollout # stopped retrying. There may be some successful resources rolled out in @@ -955,6 +965,12 @@

Method Details

"A String", ], "failedResourcesCount": "A String", # Output only. Resources failed. + "locationStatus": { # Output only. Status of each location in the wave. Map keys (locations) must be + # specified like "us-east1" or "asia-west1-a". + "a_key": { # Represents the status of a location in a wave. + "state": "A String", # Output only. Location state of the wave. + }, + }, }, "waveDisplayName": "A String", # Output only. Wave name. # Ex. wave1 diff --git a/docs/dyn/compute_alpha.securityPolicies.html b/docs/dyn/compute_alpha.securityPolicies.html index 4b949dd49a..d8175097f6 100644 --- a/docs/dyn/compute_alpha.securityPolicies.html +++ b/docs/dyn/compute_alpha.securityPolicies.html @@ -1121,20 +1121,20 @@

Method Details

"ddosProtectionConfig": { "ddosAdaptiveProtection": "A String", "ddosImpactedBaselineThreshold": 3.14, # DDoS Protection for Network Load Balancers (and VMs with public IPs) - # builds DDos mitigations that minimize collateral damage. It quantifies + # builds DDoS mitigations that minimize collateral damage. It quantifies # this as the fraction of a non-abuse baseline that's inadvertently # blocked. # # Rules whose collateral damage exceeds ddosImpactedBaselineThreshold will # not be deployed. Using a lower value will prioritize keeping collateral # damage low, possibly at the cost of its effectiveness in rate limiting - # some or all of the attack. It should typically be unset, so Advanced DDos + # some or all of the attack. It should typically be unset, so Advanced DDoS # (and Adaptive Protection) uses the best mitigation it can find. Setting # the threshold is advised if there are logs for false positive detections - # with high collateral damage, and will cause Advanced DDos to attempt to - # find a less aggressive rule that satisfies the constraint; Failing that, - # it will fall back to no mitigation (smaller attack) or to broader network - # throttles (larger attack). + # with high collateral damage, and will cause Advanced DDoS to attempt to + # find a less aggressive rule that satisfies the constraint. If a suitable + # rule cannot be found, the system falls back to either no mitigation for + # smaller attacks or broader network throttles for larger ones. "ddosProtection": "A String", }, "description": "A String", # An optional description of this resource. Provide this property when you @@ -2265,20 +2265,20 @@

Method Details

"ddosProtectionConfig": { "ddosAdaptiveProtection": "A String", "ddosImpactedBaselineThreshold": 3.14, # DDoS Protection for Network Load Balancers (and VMs with public IPs) - # builds DDos mitigations that minimize collateral damage. It quantifies + # builds DDoS mitigations that minimize collateral damage. It quantifies # this as the fraction of a non-abuse baseline that's inadvertently # blocked. # # Rules whose collateral damage exceeds ddosImpactedBaselineThreshold will # not be deployed. Using a lower value will prioritize keeping collateral # damage low, possibly at the cost of its effectiveness in rate limiting - # some or all of the attack. It should typically be unset, so Advanced DDos + # some or all of the attack. It should typically be unset, so Advanced DDoS # (and Adaptive Protection) uses the best mitigation it can find. Setting # the threshold is advised if there are logs for false positive detections - # with high collateral damage, and will cause Advanced DDos to attempt to - # find a less aggressive rule that satisfies the constraint; Failing that, - # it will fall back to no mitigation (smaller attack) or to broader network - # throttles (larger attack). + # with high collateral damage, and will cause Advanced DDoS to attempt to + # find a less aggressive rule that satisfies the constraint. If a suitable + # rule cannot be found, the system falls back to either no mitigation for + # smaller attacks or broader network throttles for larger ones. "ddosProtection": "A String", }, "description": "A String", # An optional description of this resource. Provide this property when you @@ -3543,20 +3543,20 @@

Method Details

"ddosProtectionConfig": { "ddosAdaptiveProtection": "A String", "ddosImpactedBaselineThreshold": 3.14, # DDoS Protection for Network Load Balancers (and VMs with public IPs) - # builds DDos mitigations that minimize collateral damage. It quantifies + # builds DDoS mitigations that minimize collateral damage. It quantifies # this as the fraction of a non-abuse baseline that's inadvertently # blocked. # # Rules whose collateral damage exceeds ddosImpactedBaselineThreshold will # not be deployed. Using a lower value will prioritize keeping collateral # damage low, possibly at the cost of its effectiveness in rate limiting - # some or all of the attack. It should typically be unset, so Advanced DDos + # some or all of the attack. It should typically be unset, so Advanced DDoS # (and Adaptive Protection) uses the best mitigation it can find. Setting # the threshold is advised if there are logs for false positive detections - # with high collateral damage, and will cause Advanced DDos to attempt to - # find a less aggressive rule that satisfies the constraint; Failing that, - # it will fall back to no mitigation (smaller attack) or to broader network - # throttles (larger attack). + # with high collateral damage, and will cause Advanced DDoS to attempt to + # find a less aggressive rule that satisfies the constraint. If a suitable + # rule cannot be found, the system falls back to either no mitigation for + # smaller attacks or broader network throttles for larger ones. "ddosProtection": "A String", }, "description": "A String", # An optional description of this resource. Provide this property when you @@ -4681,20 +4681,20 @@

Method Details

"ddosProtectionConfig": { "ddosAdaptiveProtection": "A String", "ddosImpactedBaselineThreshold": 3.14, # DDoS Protection for Network Load Balancers (and VMs with public IPs) - # builds DDos mitigations that minimize collateral damage. It quantifies + # builds DDoS mitigations that minimize collateral damage. It quantifies # this as the fraction of a non-abuse baseline that's inadvertently # blocked. # # Rules whose collateral damage exceeds ddosImpactedBaselineThreshold will # not be deployed. Using a lower value will prioritize keeping collateral # damage low, possibly at the cost of its effectiveness in rate limiting - # some or all of the attack. It should typically be unset, so Advanced DDos + # some or all of the attack. It should typically be unset, so Advanced DDoS # (and Adaptive Protection) uses the best mitigation it can find. Setting # the threshold is advised if there are logs for false positive detections - # with high collateral damage, and will cause Advanced DDos to attempt to - # find a less aggressive rule that satisfies the constraint; Failing that, - # it will fall back to no mitigation (smaller attack) or to broader network - # throttles (larger attack). + # with high collateral damage, and will cause Advanced DDoS to attempt to + # find a less aggressive rule that satisfies the constraint. If a suitable + # rule cannot be found, the system falls back to either no mitigation for + # smaller attacks or broader network throttles for larger ones. "ddosProtection": "A String", }, "description": "A String", # An optional description of this resource. Provide this property when you @@ -5631,20 +5631,20 @@

Method Details

"ddosProtectionConfig": { "ddosAdaptiveProtection": "A String", "ddosImpactedBaselineThreshold": 3.14, # DDoS Protection for Network Load Balancers (and VMs with public IPs) - # builds DDos mitigations that minimize collateral damage. It quantifies + # builds DDoS mitigations that minimize collateral damage. It quantifies # this as the fraction of a non-abuse baseline that's inadvertently # blocked. # # Rules whose collateral damage exceeds ddosImpactedBaselineThreshold will # not be deployed. Using a lower value will prioritize keeping collateral # damage low, possibly at the cost of its effectiveness in rate limiting - # some or all of the attack. It should typically be unset, so Advanced DDos + # some or all of the attack. It should typically be unset, so Advanced DDoS # (and Adaptive Protection) uses the best mitigation it can find. Setting # the threshold is advised if there are logs for false positive detections - # with high collateral damage, and will cause Advanced DDos to attempt to - # find a less aggressive rule that satisfies the constraint; Failing that, - # it will fall back to no mitigation (smaller attack) or to broader network - # throttles (larger attack). + # with high collateral damage, and will cause Advanced DDoS to attempt to + # find a less aggressive rule that satisfies the constraint. If a suitable + # rule cannot be found, the system falls back to either no mitigation for + # smaller attacks or broader network throttles for larger ones. "ddosProtection": "A String", }, "description": "A String", # An optional description of this resource. Provide this property when you diff --git a/docs/dyn/compute_alpha.snapshots.html b/docs/dyn/compute_alpha.snapshots.html index 79699a59f5..877af08584 100644 --- a/docs/dyn/compute_alpha.snapshots.html +++ b/docs/dyn/compute_alpha.snapshots.html @@ -114,7 +114,7 @@

Instance Methods

testIamPermissions(project, resource, body=None, x__xgafv=None)

Returns permissions that a caller has on the specified resource.

- updateKmsKey(project, snapshot, requestId=None, x__xgafv=None)

+ updateKmsKey(project, snapshot, body=None, requestId=None, x__xgafv=None)

Rotates the customer-managed

Method Details

@@ -3993,13 +3993,27 @@

Method Details

- updateKmsKey(project, snapshot, requestId=None, x__xgafv=None) + updateKmsKey(project, snapshot, body=None, requestId=None, x__xgafv=None)
Rotates the customer-managed
 encryption key to the latest version for the specified snapshot.
 
 Args:
   project: string, Project ID for this request. (required)
   snapshot: string, Name of the snapshot resource to update. Should conform to RFC1035. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "kmsKeyName": "A String", # Optional. The new KMS key to replace the current one on the snapshot. If empty, the
+      # snapshot will be re-encrypted using the primary version of the snapshot's
+      # current KMS key.
+      # 
+      # The KMS key can be provided in the following formats:
+      # 
+      # 
+      #      - projects/project_id/locations/region/keyRings/key_ring/cryptoKeys/key
+}
+
   requestId: string, An optional request ID to identify requests. Specify a unique request ID so
 that if you must retry your request, the server will know to ignore the
 request if it has already been completed.
diff --git a/docs/dyn/compute_alpha.sslPolicies.html b/docs/dyn/compute_alpha.sslPolicies.html
index 25d624d7eb..b890cb2377 100644
--- a/docs/dyn/compute_alpha.sslPolicies.html
+++ b/docs/dyn/compute_alpha.sslPolicies.html
@@ -267,12 +267,14 @@ 

Method Details

# negotiating X25519MLKEM768 key exchange when clients advertise support for # it. When set to DEFAULT, or if no SSL Policy is # attached to the target proxy, the load balancer disallows X25519MLKEM768 - # key exchange until it is enabled by default on LBs. When set toENABLED, the load balancer will negotiate X25519MLKEM768 key - # exchange. Customers can set this to DEFERRED to temporarily - # opt-out the LB from negotiating post-quantum key exchange by default. + # key exchange until it is enabled by default on load balancers. When set toENABLED, the load balancer can negotiate X25519MLKEM768 key + # exchange. When set to DEFERRED, temporarily opts out the load + # balancer from negotiating X25519MLKEM768 beyond the point where it is + # enabled by default on load balancers. "profile": "A String", # Profile specifies the set of SSL features that can be used by the load - # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features - # to enable must be specified in the customFeatures field. + # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED,FIPS_202205, or CUSTOM. If usingCUSTOM, the set of SSL features to enable must be specified in + # the customFeatures field. If using FIPS_202205, + # the min_tls_version field must be set to TLS_1_2. "region": "A String", # Output only. [Output Only] URL of the region where the regional SSL policy # resides. This field is not applicable to global SSL policies. "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. @@ -859,12 +861,14 @@

Method Details

# negotiating X25519MLKEM768 key exchange when clients advertise support for # it. When set to DEFAULT, or if no SSL Policy is # attached to the target proxy, the load balancer disallows X25519MLKEM768 - # key exchange until it is enabled by default on LBs. When set toENABLED, the load balancer will negotiate X25519MLKEM768 key - # exchange. Customers can set this to DEFERRED to temporarily - # opt-out the LB from negotiating post-quantum key exchange by default. + # key exchange until it is enabled by default on load balancers. When set toENABLED, the load balancer can negotiate X25519MLKEM768 key + # exchange. When set to DEFERRED, temporarily opts out the load + # balancer from negotiating X25519MLKEM768 beyond the point where it is + # enabled by default on load balancers. "profile": "A String", # Profile specifies the set of SSL features that can be used by the load - # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features - # to enable must be specified in the customFeatures field. + # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED,FIPS_202205, or CUSTOM. If usingCUSTOM, the set of SSL features to enable must be specified in + # the customFeatures field. If using FIPS_202205, + # the min_tls_version field must be set to TLS_1_2. "region": "A String", # Output only. [Output Only] URL of the region where the regional SSL policy # resides. This field is not applicable to global SSL policies. "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. @@ -1064,12 +1068,14 @@

Method Details

# negotiating X25519MLKEM768 key exchange when clients advertise support for # it. When set to DEFAULT, or if no SSL Policy is # attached to the target proxy, the load balancer disallows X25519MLKEM768 - # key exchange until it is enabled by default on LBs. When set toENABLED, the load balancer will negotiate X25519MLKEM768 key - # exchange. Customers can set this to DEFERRED to temporarily - # opt-out the LB from negotiating post-quantum key exchange by default. + # key exchange until it is enabled by default on load balancers. When set toENABLED, the load balancer can negotiate X25519MLKEM768 key + # exchange. When set to DEFERRED, temporarily opts out the load + # balancer from negotiating X25519MLKEM768 beyond the point where it is + # enabled by default on load balancers. "profile": "A String", # Profile specifies the set of SSL features that can be used by the load - # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features - # to enable must be specified in the customFeatures field. + # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED,FIPS_202205, or CUSTOM. If usingCUSTOM, the set of SSL features to enable must be specified in + # the customFeatures field. If using FIPS_202205, + # the min_tls_version field must be set to TLS_1_2. "region": "A String", # Output only. [Output Only] URL of the region where the regional SSL policy # resides. This field is not applicable to global SSL policies. "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. @@ -1646,12 +1652,14 @@

Method Details

# negotiating X25519MLKEM768 key exchange when clients advertise support for # it. When set to DEFAULT, or if no SSL Policy is # attached to the target proxy, the load balancer disallows X25519MLKEM768 - # key exchange until it is enabled by default on LBs. When set toENABLED, the load balancer will negotiate X25519MLKEM768 key - # exchange. Customers can set this to DEFERRED to temporarily - # opt-out the LB from negotiating post-quantum key exchange by default. + # key exchange until it is enabled by default on load balancers. When set toENABLED, the load balancer can negotiate X25519MLKEM768 key + # exchange. When set to DEFERRED, temporarily opts out the load + # balancer from negotiating X25519MLKEM768 beyond the point where it is + # enabled by default on load balancers. "profile": "A String", # Profile specifies the set of SSL features that can be used by the load - # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features - # to enable must be specified in the customFeatures field. + # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED,FIPS_202205, or CUSTOM. If usingCUSTOM, the set of SSL features to enable must be specified in + # the customFeatures field. If using FIPS_202205, + # the min_tls_version field must be set to TLS_1_2. "region": "A String", # Output only. [Output Only] URL of the region where the regional SSL policy # resides. This field is not applicable to global SSL policies. "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. @@ -2006,12 +2014,14 @@

Method Details

# negotiating X25519MLKEM768 key exchange when clients advertise support for # it. When set to DEFAULT, or if no SSL Policy is # attached to the target proxy, the load balancer disallows X25519MLKEM768 - # key exchange until it is enabled by default on LBs. When set toENABLED, the load balancer will negotiate X25519MLKEM768 key - # exchange. Customers can set this to DEFERRED to temporarily - # opt-out the LB from negotiating post-quantum key exchange by default. + # key exchange until it is enabled by default on load balancers. When set toENABLED, the load balancer can negotiate X25519MLKEM768 key + # exchange. When set to DEFERRED, temporarily opts out the load + # balancer from negotiating X25519MLKEM768 beyond the point where it is + # enabled by default on load balancers. "profile": "A String", # Profile specifies the set of SSL features that can be used by the load - # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features - # to enable must be specified in the customFeatures field. + # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED,FIPS_202205, or CUSTOM. If usingCUSTOM, the set of SSL features to enable must be specified in + # the customFeatures field. If using FIPS_202205, + # the min_tls_version field must be set to TLS_1_2. "region": "A String", # Output only. [Output Only] URL of the region where the regional SSL policy # resides. This field is not applicable to global SSL policies. "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. diff --git a/docs/dyn/compute_alpha.subnetworks.html b/docs/dyn/compute_alpha.subnetworks.html index ba2fc43429..dad45c5428 100644 --- a/docs/dyn/compute_alpha.subnetworks.html +++ b/docs/dyn/compute_alpha.subnetworks.html @@ -345,6 +345,10 @@

Method Details

# instances and Forwarding Rules. It can also be used to reserve IPv6 # addresses with both VM and FR endpoint types. Such a subnetwork gets its # IPv6 range from Google IP Pool directly. + "ipv6NetworkTier": "A String", # Specifies the network tier for EXTERNAL IPv6. Can only be set when + # ipv6_access_type is EXTERNAL. Defaults to project defaultNetworkTier if not + # specified during the creation of the subnetwork. This field is IMMUTABLE + # once set with EXTERNAL IPv6. "kind": "compute#subnetwork", # Output only. [Output Only] Type of the resource. Always compute#subnetwork # for Subnetwork resources. "logConfig": { # The available logging options for this subnetwork. # This field denotes the VPC flow logging options for this subnetwork. @@ -1333,6 +1337,10 @@

Method Details

# instances and Forwarding Rules. It can also be used to reserve IPv6 # addresses with both VM and FR endpoint types. Such a subnetwork gets its # IPv6 range from Google IP Pool directly. + "ipv6NetworkTier": "A String", # Specifies the network tier for EXTERNAL IPv6. Can only be set when + # ipv6_access_type is EXTERNAL. Defaults to project defaultNetworkTier if not + # specified during the creation of the subnetwork. This field is IMMUTABLE + # once set with EXTERNAL IPv6. "kind": "compute#subnetwork", # Output only. [Output Only] Type of the resource. Always compute#subnetwork # for Subnetwork resources. "logConfig": { # The available logging options for this subnetwork. # This field denotes the VPC flow logging options for this subnetwork. @@ -1994,6 +2002,10 @@

Method Details

# instances and Forwarding Rules. It can also be used to reserve IPv6 # addresses with both VM and FR endpoint types. Such a subnetwork gets its # IPv6 range from Google IP Pool directly. + "ipv6NetworkTier": "A String", # Specifies the network tier for EXTERNAL IPv6. Can only be set when + # ipv6_access_type is EXTERNAL. Defaults to project defaultNetworkTier if not + # specified during the creation of the subnetwork. This field is IMMUTABLE + # once set with EXTERNAL IPv6. "kind": "compute#subnetwork", # Output only. [Output Only] Type of the resource. Always compute#subnetwork # for Subnetwork resources. "logConfig": { # The available logging options for this subnetwork. # This field denotes the VPC flow logging options for this subnetwork. @@ -2670,6 +2682,10 @@

Method Details

# instances and Forwarding Rules. It can also be used to reserve IPv6 # addresses with both VM and FR endpoint types. Such a subnetwork gets its # IPv6 range from Google IP Pool directly. + "ipv6NetworkTier": "A String", # Specifies the network tier for EXTERNAL IPv6. Can only be set when + # ipv6_access_type is EXTERNAL. Defaults to project defaultNetworkTier if not + # specified during the creation of the subnetwork. This field is IMMUTABLE + # once set with EXTERNAL IPv6. "kind": "compute#subnetwork", # Output only. [Output Only] Type of the resource. Always compute#subnetwork # for Subnetwork resources. "logConfig": { # The available logging options for this subnetwork. # This field denotes the VPC flow logging options for this subnetwork. @@ -3240,6 +3256,10 @@

Method Details

# instances and Forwarding Rules. It can also be used to reserve IPv6 # addresses with both VM and FR endpoint types. Such a subnetwork gets its # IPv6 range from Google IP Pool directly. + "ipv6NetworkTier": "A String", # Specifies the network tier for EXTERNAL IPv6. Can only be set when + # ipv6_access_type is EXTERNAL. Defaults to project defaultNetworkTier if not + # specified during the creation of the subnetwork. This field is IMMUTABLE + # once set with EXTERNAL IPv6. "kind": "compute#subnetwork", # Output only. [Output Only] Type of the resource. Always compute#subnetwork # for Subnetwork resources. "logConfig": { # The available logging options for this subnetwork. # This field denotes the VPC flow logging options for this subnetwork. diff --git a/docs/dyn/compute_alpha.urlMaps.html b/docs/dyn/compute_alpha.urlMaps.html index b049f2d5c2..1cfb51bfa0 100644 --- a/docs/dyn/compute_alpha.urlMaps.html +++ b/docs/dyn/compute_alpha.urlMaps.html @@ -677,6 +677,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -1514,6 +1525,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -2332,6 +2354,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -3412,6 +3445,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -4630,6 +4674,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -5467,6 +5522,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -6285,6 +6351,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -7365,6 +7442,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -8201,6 +8289,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -9038,6 +9137,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -9856,6 +9966,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -10936,6 +11057,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -12479,6 +12611,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -13316,6 +13459,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -14134,6 +14288,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -15214,6 +15379,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -16101,6 +16277,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -16938,6 +17125,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -17756,6 +17954,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -18836,6 +19045,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -19991,6 +20211,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -20828,6 +21059,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -21646,6 +21888,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -22726,6 +22979,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -23867,6 +24131,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -24704,6 +24979,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -25522,6 +25808,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -26602,6 +26899,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map’s route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), diff --git a/docs/dyn/compute_alpha.zoneQueuedResources.html b/docs/dyn/compute_alpha.zoneQueuedResources.html index 6676641752..3374d719de 100644 --- a/docs/dyn/compute_alpha.zoneQueuedResources.html +++ b/docs/dyn/compute_alpha.zoneQueuedResources.html @@ -1398,6 +1398,17 @@

Method Details

# alias range. If not specified, the primary range of the subnetwork is used. }, ], + "aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. + # You can only specify this field for network interfaces in VPC networks. + { # An alias IP range attached to an instance's network interface. + "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range + # must belong to the specified subnetwork and cannot contain IP addresses + # reserved by system or used by other network interfaces. This range may be + # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24). + "subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP + # alias range. If not specified, the primary range of the subnetwork is used. + }, + ], "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid # with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. @@ -3920,6 +3931,17 @@

Method Details

# alias range. If not specified, the primary range of the subnetwork is used. }, ], + "aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. + # You can only specify this field for network interfaces in VPC networks. + { # An alias IP range attached to an instance's network interface. + "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range + # must belong to the specified subnetwork and cannot contain IP addresses + # reserved by system or used by other network interfaces. This range may be + # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24). + "subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP + # alias range. If not specified, the primary range of the subnetwork is used. + }, + ], "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid # with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. @@ -5758,6 +5780,17 @@

Method Details

# alias range. If not specified, the primary range of the subnetwork is used. }, ], + "aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. + # You can only specify this field for network interfaces in VPC networks. + { # An alias IP range attached to an instance's network interface. + "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range + # must belong to the specified subnetwork and cannot contain IP addresses + # reserved by system or used by other network interfaces. This range may be + # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24). + "subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP + # alias range. If not specified, the primary range of the subnetwork is used. + }, + ], "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid # with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. @@ -7972,6 +8005,17 @@

Method Details

# alias range. If not specified, the primary range of the subnetwork is used. }, ], + "aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. + # You can only specify this field for network interfaces in VPC networks. + { # An alias IP range attached to an instance's network interface. + "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range + # must belong to the specified subnetwork and cannot contain IP addresses + # reserved by system or used by other network interfaces. This range may be + # a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24). + "subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP + # alias range. If not specified, the primary range of the subnetwork is used. + }, + ], "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid # with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. diff --git a/docs/dyn/compute_beta.addresses.html b/docs/dyn/compute_beta.addresses.html index 9d76d518b9..8f68ab6124 100644 --- a/docs/dyn/compute_beta.addresses.html +++ b/docs/dyn/compute_beta.addresses.html @@ -582,6 +582,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1107,6 +1119,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1668,6 +1692,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1965,6 +2001,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.autoscalers.html b/docs/dyn/compute_beta.autoscalers.html index 63c43cfc0c..44bce0f1d1 100644 --- a/docs/dyn/compute_beta.autoscalers.html +++ b/docs/dyn/compute_beta.autoscalers.html @@ -830,6 +830,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1849,6 +1861,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3006,6 +3030,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3684,6 +3720,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.backendBuckets.html b/docs/dyn/compute_beta.backendBuckets.html index f7cc9cd65d..00d9965963 100644 --- a/docs/dyn/compute_beta.backendBuckets.html +++ b/docs/dyn/compute_beta.backendBuckets.html @@ -306,6 +306,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -975,6 +987,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1258,6 +1282,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2309,6 +2345,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3471,6 +3519,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3759,6 +3819,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5142,6 +5214,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.backendServices.html b/docs/dyn/compute_beta.backendServices.html index f8211aa862..ec5ecb9c21 100644 --- a/docs/dyn/compute_beta.backendServices.html +++ b/docs/dyn/compute_beta.backendServices.html @@ -315,6 +315,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1030,6 +1042,10 @@

Method Details

"dynamicForwarding": { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the # backend service with dynamic forwarding feature which together with Service # Extension allows customized and complex routing logic. + "forwardProxy": { # Defines Dynamic Forwarding Proxy configuration. # Dynamic Forwarding Proxy configuration. + "enabled": True or False, # A boolean flag enabling dynamic forwarding proxy. + "proxyMode": "A String", # Determines the dynamic forwarding proxy mode. + }, "ipPortSelection": { # Defines a IP:PORT based dynamic forwarding configuration for the backend # IP:PORT based dynamic forwarding configuration. # service. Some ranges are restricted: Restricted # ranges. @@ -1088,7 +1104,7 @@

Method Details

# draining traffic. A setting of false allows existing TCP # connections to persist, even on VMs no longer in the active pool, for up # to the duration of the connection draining timeout (10 minutes). - "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol isTCP. + "disableConnectionDrainOnFailover": True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. # # The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the @@ -2130,6 +2146,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2413,6 +2441,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3028,6 +3068,10 @@

Method Details

"dynamicForwarding": { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the # backend service with dynamic forwarding feature which together with Service # Extension allows customized and complex routing logic. + "forwardProxy": { # Defines Dynamic Forwarding Proxy configuration. # Dynamic Forwarding Proxy configuration. + "enabled": True or False, # A boolean flag enabling dynamic forwarding proxy. + "proxyMode": "A String", # Determines the dynamic forwarding proxy mode. + }, "ipPortSelection": { # Defines a IP:PORT based dynamic forwarding configuration for the backend # IP:PORT based dynamic forwarding configuration. # service. Some ranges are restricted: Restricted # ranges. @@ -3086,7 +3130,7 @@

Method Details

# draining traffic. A setting of false allows existing TCP # connections to persist, even on VMs no longer in the active pool, for up # to the duration of the connection draining timeout (10 minutes). - "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol isTCP. + "disableConnectionDrainOnFailover": True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. # # The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the @@ -3995,20 +4039,20 @@

Method Details

"ddosProtectionConfig": { "ddosAdaptiveProtection": "A String", "ddosImpactedBaselineThreshold": 3.14, # DDoS Protection for Network Load Balancers (and VMs with public IPs) - # builds DDos mitigations that minimize collateral damage. It quantifies + # builds DDoS mitigations that minimize collateral damage. It quantifies # this as the fraction of a non-abuse baseline that's inadvertently # blocked. # # Rules whose collateral damage exceeds ddosImpactedBaselineThreshold will # not be deployed. Using a lower value will prioritize keeping collateral # damage low, possibly at the cost of its effectiveness in rate limiting - # some or all of the attack. It should typically be unset, so Advanced DDos + # some or all of the attack. It should typically be unset, so Advanced DDoS # (and Adaptive Protection) uses the best mitigation it can find. Setting # the threshold is advised if there are logs for false positive detections - # with high collateral damage, and will cause Advanced DDos to attempt to - # find a less aggressive rule that satisfies the constraint; Failing that, - # it will fall back to no mitigation (smaller attack) or to broader network - # throttles (larger attack). + # with high collateral damage, and will cause Advanced DDoS to attempt to + # find a less aggressive rule that satisfies the constraint. If a suitable + # rule cannot be found, the system falls back to either no mitigation for + # smaller attacks or broader network throttles for larger ones. "ddosProtection": "A String", }, "description": "A String", # An optional description of this resource. Provide this property when you @@ -5538,6 +5582,10 @@

Method Details

"dynamicForwarding": { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the # backend service with dynamic forwarding feature which together with Service # Extension allows customized and complex routing logic. + "forwardProxy": { # Defines Dynamic Forwarding Proxy configuration. # Dynamic Forwarding Proxy configuration. + "enabled": True or False, # A boolean flag enabling dynamic forwarding proxy. + "proxyMode": "A String", # Determines the dynamic forwarding proxy mode. + }, "ipPortSelection": { # Defines a IP:PORT based dynamic forwarding configuration for the backend # IP:PORT based dynamic forwarding configuration. # service. Some ranges are restricted: Restricted # ranges. @@ -5596,7 +5644,7 @@

Method Details

# draining traffic. A setting of false allows existing TCP # connections to persist, even on VMs no longer in the active pool, for up # to the duration of the connection draining timeout (10 minutes). - "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol isTCP. + "disableConnectionDrainOnFailover": True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. # # The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the @@ -6546,6 +6594,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -7247,6 +7307,10 @@

Method Details

"dynamicForwarding": { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the # backend service with dynamic forwarding feature which together with Service # Extension allows customized and complex routing logic. + "forwardProxy": { # Defines Dynamic Forwarding Proxy configuration. # Dynamic Forwarding Proxy configuration. + "enabled": True or False, # A boolean flag enabling dynamic forwarding proxy. + "proxyMode": "A String", # Determines the dynamic forwarding proxy mode. + }, "ipPortSelection": { # Defines a IP:PORT based dynamic forwarding configuration for the backend # IP:PORT based dynamic forwarding configuration. # service. Some ranges are restricted: Restricted # ranges. @@ -7305,7 +7369,7 @@

Method Details

# draining traffic. A setting of false allows existing TCP # connections to persist, even on VMs no longer in the active pool, for up # to the duration of the connection draining timeout (10 minutes). - "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol isTCP. + "disableConnectionDrainOnFailover": True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. # # The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the @@ -8717,6 +8781,10 @@

Method Details

"dynamicForwarding": { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the # backend service with dynamic forwarding feature which together with Service # Extension allows customized and complex routing logic. + "forwardProxy": { # Defines Dynamic Forwarding Proxy configuration. # Dynamic Forwarding Proxy configuration. + "enabled": True or False, # A boolean flag enabling dynamic forwarding proxy. + "proxyMode": "A String", # Determines the dynamic forwarding proxy mode. + }, "ipPortSelection": { # Defines a IP:PORT based dynamic forwarding configuration for the backend # IP:PORT based dynamic forwarding configuration. # service. Some ranges are restricted: Restricted # ranges. @@ -8775,7 +8843,7 @@

Method Details

# draining traffic. A setting of false allows existing TCP # connections to persist, even on VMs no longer in the active pool, for up # to the duration of the connection draining timeout (10 minutes). - "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol isTCP. + "disableConnectionDrainOnFailover": True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. # # The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the @@ -10130,6 +10198,10 @@

Method Details

"dynamicForwarding": { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the # backend service with dynamic forwarding feature which together with Service # Extension allows customized and complex routing logic. + "forwardProxy": { # Defines Dynamic Forwarding Proxy configuration. # Dynamic Forwarding Proxy configuration. + "enabled": True or False, # A boolean flag enabling dynamic forwarding proxy. + "proxyMode": "A String", # Determines the dynamic forwarding proxy mode. + }, "ipPortSelection": { # Defines a IP:PORT based dynamic forwarding configuration for the backend # IP:PORT based dynamic forwarding configuration. # service. Some ranges are restricted: Restricted # ranges. @@ -10188,7 +10260,7 @@

Method Details

# draining traffic. A setting of false allows existing TCP # connections to persist, even on VMs no longer in the active pool, for up # to the duration of the connection draining timeout (10 minutes). - "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol isTCP. + "disableConnectionDrainOnFailover": True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. # # The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the @@ -11138,6 +11210,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -11426,6 +11510,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -12590,6 +12686,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -13235,6 +13343,10 @@

Method Details

"dynamicForwarding": { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the # backend service with dynamic forwarding feature which together with Service # Extension allows customized and complex routing logic. + "forwardProxy": { # Defines Dynamic Forwarding Proxy configuration. # Dynamic Forwarding Proxy configuration. + "enabled": True or False, # A boolean flag enabling dynamic forwarding proxy. + "proxyMode": "A String", # Determines the dynamic forwarding proxy mode. + }, "ipPortSelection": { # Defines a IP:PORT based dynamic forwarding configuration for the backend # IP:PORT based dynamic forwarding configuration. # service. Some ranges are restricted: Restricted # ranges. @@ -13293,7 +13405,7 @@

Method Details

# draining traffic. A setting of false allows existing TCP # connections to persist, even on VMs no longer in the active pool, for up # to the duration of the connection draining timeout (10 minutes). - "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol isTCP. + "disableConnectionDrainOnFailover": True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. # # The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the @@ -14243,6 +14355,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.crossSiteNetworks.html b/docs/dyn/compute_beta.crossSiteNetworks.html index eee75ddf93..8c6d9dbc79 100644 --- a/docs/dyn/compute_beta.crossSiteNetworks.html +++ b/docs/dyn/compute_beta.crossSiteNetworks.html @@ -263,6 +263,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -604,6 +616,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1087,6 +1111,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.diskSettings.html b/docs/dyn/compute_beta.diskSettings.html index 47bd775bd3..fcec932164 100644 --- a/docs/dyn/compute_beta.diskSettings.html +++ b/docs/dyn/compute_beta.diskSettings.html @@ -324,6 +324,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.disks.html b/docs/dyn/compute_beta.disks.html index afffd2e207..615d33a291 100644 --- a/docs/dyn/compute_beta.disks.html +++ b/docs/dyn/compute_beta.disks.html @@ -315,6 +315,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1373,6 +1385,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1674,6 +1698,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2289,6 +2325,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2574,6 +2622,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -4320,6 +4380,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5298,6 +5370,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5587,6 +5671,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6759,6 +6855,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -7069,6 +7177,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -7351,6 +7471,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -7653,6 +7785,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -8511,6 +8655,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.externalVpnGateways.html b/docs/dyn/compute_beta.externalVpnGateways.html index fd931f64e2..ebb982da3f 100644 --- a/docs/dyn/compute_beta.externalVpnGateways.html +++ b/docs/dyn/compute_beta.externalVpnGateways.html @@ -265,6 +265,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -739,6 +751,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1264,6 +1288,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.firewallPolicies.html b/docs/dyn/compute_beta.firewallPolicies.html index 1d2e347383..ed65bd3b01 100644 --- a/docs/dyn/compute_beta.firewallPolicies.html +++ b/docs/dyn/compute_beta.firewallPolicies.html @@ -328,6 +328,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -796,6 +808,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1264,6 +1288,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1544,6 +1580,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1828,6 +1876,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3848,6 +3908,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -4780,6 +4852,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5521,6 +5605,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5990,6 +6086,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6459,6 +6567,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6739,6 +6859,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -7019,6 +7151,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -7299,6 +7443,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.firewalls.html b/docs/dyn/compute_beta.firewalls.html index b00d37802b..0931dd0fd9 100644 --- a/docs/dyn/compute_beta.firewalls.html +++ b/docs/dyn/compute_beta.firewalls.html @@ -268,6 +268,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -905,6 +917,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1680,6 +1704,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2168,6 +2204,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.forwardingRules.html b/docs/dyn/compute_beta.forwardingRules.html index a224356d62..4f704cf52d 100644 --- a/docs/dyn/compute_beta.forwardingRules.html +++ b/docs/dyn/compute_beta.forwardingRules.html @@ -861,6 +861,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1940,6 +1952,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3157,6 +3181,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3455,6 +3491,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3744,6 +3792,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.futureReservations.html b/docs/dyn/compute_beta.futureReservations.html index 94f97935d8..dfcb8c69e3 100644 --- a/docs/dyn/compute_beta.futureReservations.html +++ b/docs/dyn/compute_beta.futureReservations.html @@ -774,6 +774,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1060,6 +1072,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1982,6 +2006,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3046,6 +3082,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.globalAddresses.html b/docs/dyn/compute_beta.globalAddresses.html index fb7ba320dd..c03f000897 100644 --- a/docs/dyn/compute_beta.globalAddresses.html +++ b/docs/dyn/compute_beta.globalAddresses.html @@ -268,6 +268,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -791,6 +803,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1349,6 +1373,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1635,6 +1671,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.globalForwardingRules.html b/docs/dyn/compute_beta.globalForwardingRules.html index 3ec25c7697..47ff9730fe 100644 --- a/docs/dyn/compute_beta.globalForwardingRules.html +++ b/docs/dyn/compute_beta.globalForwardingRules.html @@ -271,6 +271,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1349,6 +1361,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2564,6 +2588,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2851,6 +2887,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3139,6 +3187,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.globalNetworkEndpointGroups.html b/docs/dyn/compute_beta.globalNetworkEndpointGroups.html index a02c25ade9..4e160fb2b1 100644 --- a/docs/dyn/compute_beta.globalNetworkEndpointGroups.html +++ b/docs/dyn/compute_beta.globalNetworkEndpointGroups.html @@ -311,6 +311,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -598,6 +610,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -923,6 +947,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1670,6 +1706,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.globalOperations.html b/docs/dyn/compute_beta.globalOperations.html index b45cd59740..af6299a2c9 100644 --- a/docs/dyn/compute_beta.globalOperations.html +++ b/docs/dyn/compute_beta.globalOperations.html @@ -347,6 +347,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -716,6 +728,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1070,6 +1094,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1403,6 +1439,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.globalOrganizationOperations.html b/docs/dyn/compute_beta.globalOrganizationOperations.html index 593266dec2..8eebffa710 100644 --- a/docs/dyn/compute_beta.globalOrganizationOperations.html +++ b/docs/dyn/compute_beta.globalOrganizationOperations.html @@ -260,6 +260,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -614,6 +626,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.globalPublicDelegatedPrefixes.html b/docs/dyn/compute_beta.globalPublicDelegatedPrefixes.html index a3b0c2c725..ff750e97db 100644 --- a/docs/dyn/compute_beta.globalPublicDelegatedPrefixes.html +++ b/docs/dyn/compute_beta.globalPublicDelegatedPrefixes.html @@ -262,6 +262,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -725,6 +737,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1325,6 +1349,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.globalVmExtensionPolicies.html b/docs/dyn/compute_beta.globalVmExtensionPolicies.html index 37fb413b2d..cf964f3d66 100644 --- a/docs/dyn/compute_beta.globalVmExtensionPolicies.html +++ b/docs/dyn/compute_beta.globalVmExtensionPolicies.html @@ -384,12 +384,14 @@

Method Details

# methods. # # A conflict occurs in the following cases: + # # * `insert` method: If the zonal policy already exists when the insert # happens. # * `update` method: If the zonal policy was modified by a zonal API call # outside of this rollout. # # Possible values are the following: + # # * `""` (empty string): If a conflict occurs, the local value is not # overwritten. This is the default behavior. # * `"overwrite"`: If a conflict occurs, the local value is overwritten @@ -397,7 +399,10 @@

Method Details

"name": "A String", # Optional. The name of the rollout plan. # Ex. # projects//locations/global/rolloutPlans/. - "predefinedRolloutPlan": "A String", # Optional. Predefined rollout plan. + "predefinedRolloutPlan": "A String", # Optional. Specifies the predefined rollout plan for the policy. Valid values + # are `SLOW_ROLLOUT` and `FAST_ROLLOUT`. The recommended value is + # `SLOW_ROLLOUT` for progressive rollout. For more information, see Rollout + # plans for global policies. "retryUuid": "A String", # Optional. The UUID that identifies a policy rollout retry attempt for update and # delete operations. Set this field only when retrying a rollout for an # existing extension policy. @@ -564,6 +569,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -748,12 +765,14 @@

Method Details

# methods. # # A conflict occurs in the following cases: + # # * `insert` method: If the zonal policy already exists when the insert # happens. # * `update` method: If the zonal policy was modified by a zonal API call # outside of this rollout. # # Possible values are the following: + # # * `""` (empty string): If a conflict occurs, the local value is not # overwritten. This is the default behavior. # * `"overwrite"`: If a conflict occurs, the local value is overwritten @@ -761,7 +780,10 @@

Method Details

"name": "A String", # Optional. The name of the rollout plan. # Ex. # projects//locations/global/rolloutPlans/. - "predefinedRolloutPlan": "A String", # Optional. Predefined rollout plan. + "predefinedRolloutPlan": "A String", # Optional. Specifies the predefined rollout plan for the policy. Valid values + # are `SLOW_ROLLOUT` and `FAST_ROLLOUT`. The recommended value is + # `SLOW_ROLLOUT` for progressive rollout. For more information, see Rollout + # plans for global policies. "retryUuid": "A String", # Optional. The UUID that identifies a policy rollout retry attempt for update and # delete operations. Set this field only when retrying a rollout for an # existing extension policy. @@ -778,6 +800,12 @@

Method Details

# resource. There should be only one current rollout, but for # scalability, we make it repeated. { + "locationRolloutStatus": { # Output only. [Output Only] The rollout status for each location. The list of the + # locations is the same as the list of locations in the rollout plan. + "a_key": { + "state": "A String", # Output only. [Output Only] The state of the location rollout. + }, + }, "rollout": "A String", # Output only. [Output Only] The name of the rollout. # Ex. projects//locations/global/rollouts/. "rolloutPlan": "A String", # Output only. [Output Only] The name of the rollout plan. @@ -788,6 +816,12 @@

Method Details

], "previousRollout": { # Output only. [Output Only] The last completed rollout resource. This field will not # be populated until the first rollout is completed. + "locationRolloutStatus": { # Output only. [Output Only] The rollout status for each location. The list of the + # locations is the same as the list of locations in the rollout plan. + "a_key": { + "state": "A String", # Output only. [Output Only] The state of the location rollout. + }, + }, "rollout": "A String", # Output only. [Output Only] The name of the rollout. # Ex. projects//locations/global/rollouts/. "rolloutPlan": "A String", # Output only. [Output Only] The name of the rollout plan. @@ -865,12 +899,14 @@

Method Details

# methods. # # A conflict occurs in the following cases: + # # * `insert` method: If the zonal policy already exists when the insert # happens. # * `update` method: If the zonal policy was modified by a zonal API call # outside of this rollout. # # Possible values are the following: + # # * `""` (empty string): If a conflict occurs, the local value is not # overwritten. This is the default behavior. # * `"overwrite"`: If a conflict occurs, the local value is overwritten @@ -878,7 +914,10 @@

Method Details

"name": "A String", # Optional. The name of the rollout plan. # Ex. # projects//locations/global/rolloutPlans/. - "predefinedRolloutPlan": "A String", # Optional. Predefined rollout plan. + "predefinedRolloutPlan": "A String", # Optional. Specifies the predefined rollout plan for the policy. Valid values + # are `SLOW_ROLLOUT` and `FAST_ROLLOUT`. The recommended value is + # `SLOW_ROLLOUT` for progressive rollout. For more information, see Rollout + # plans for global policies. "retryUuid": "A String", # Optional. The UUID that identifies a policy rollout retry attempt for update and # delete operations. Set this field only when retrying a rollout for an # existing extension policy. @@ -895,6 +934,12 @@

Method Details

# resource. There should be only one current rollout, but for # scalability, we make it repeated. { + "locationRolloutStatus": { # Output only. [Output Only] The rollout status for each location. The list of the + # locations is the same as the list of locations in the rollout plan. + "a_key": { + "state": "A String", # Output only. [Output Only] The state of the location rollout. + }, + }, "rollout": "A String", # Output only. [Output Only] The name of the rollout. # Ex. projects//locations/global/rollouts/. "rolloutPlan": "A String", # Output only. [Output Only] The name of the rollout plan. @@ -905,6 +950,12 @@

Method Details

], "previousRollout": { # Output only. [Output Only] The last completed rollout resource. This field will not # be populated until the first rollout is completed. + "locationRolloutStatus": { # Output only. [Output Only] The rollout status for each location. The list of the + # locations is the same as the list of locations in the rollout plan. + "a_key": { + "state": "A String", # Output only. [Output Only] The state of the location rollout. + }, + }, "rollout": "A String", # Output only. [Output Only] The name of the rollout. # Ex. projects//locations/global/rollouts/. "rolloutPlan": "A String", # Output only. [Output Only] The name of the rollout plan. @@ -1076,6 +1127,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1346,12 +1409,14 @@

Method Details

# methods. # # A conflict occurs in the following cases: + # # * `insert` method: If the zonal policy already exists when the insert # happens. # * `update` method: If the zonal policy was modified by a zonal API call # outside of this rollout. # # Possible values are the following: + # # * `""` (empty string): If a conflict occurs, the local value is not # overwritten. This is the default behavior. # * `"overwrite"`: If a conflict occurs, the local value is overwritten @@ -1359,7 +1424,10 @@

Method Details

"name": "A String", # Optional. The name of the rollout plan. # Ex. # projects//locations/global/rolloutPlans/. - "predefinedRolloutPlan": "A String", # Optional. Predefined rollout plan. + "predefinedRolloutPlan": "A String", # Optional. Specifies the predefined rollout plan for the policy. Valid values + # are `SLOW_ROLLOUT` and `FAST_ROLLOUT`. The recommended value is + # `SLOW_ROLLOUT` for progressive rollout. For more information, see Rollout + # plans for global policies. "retryUuid": "A String", # Optional. The UUID that identifies a policy rollout retry attempt for update and # delete operations. Set this field only when retrying a rollout for an # existing extension policy. @@ -1376,6 +1444,12 @@

Method Details

# resource. There should be only one current rollout, but for # scalability, we make it repeated. { + "locationRolloutStatus": { # Output only. [Output Only] The rollout status for each location. The list of the + # locations is the same as the list of locations in the rollout plan. + "a_key": { + "state": "A String", # Output only. [Output Only] The state of the location rollout. + }, + }, "rollout": "A String", # Output only. [Output Only] The name of the rollout. # Ex. projects//locations/global/rollouts/. "rolloutPlan": "A String", # Output only. [Output Only] The name of the rollout plan. @@ -1386,6 +1460,12 @@

Method Details

], "previousRollout": { # Output only. [Output Only] The last completed rollout resource. This field will not # be populated until the first rollout is completed. + "locationRolloutStatus": { # Output only. [Output Only] The rollout status for each location. The list of the + # locations is the same as the list of locations in the rollout plan. + "a_key": { + "state": "A String", # Output only. [Output Only] The state of the location rollout. + }, + }, "rollout": "A String", # Output only. [Output Only] The name of the rollout. # Ex. projects//locations/global/rollouts/. "rolloutPlan": "A String", # Output only. [Output Only] The name of the rollout plan. @@ -1515,12 +1595,14 @@

Method Details

# methods. # # A conflict occurs in the following cases: + # # * `insert` method: If the zonal policy already exists when the insert # happens. # * `update` method: If the zonal policy was modified by a zonal API call # outside of this rollout. # # Possible values are the following: + # # * `""` (empty string): If a conflict occurs, the local value is not # overwritten. This is the default behavior. # * `"overwrite"`: If a conflict occurs, the local value is overwritten @@ -1528,7 +1610,10 @@

Method Details

"name": "A String", # Optional. The name of the rollout plan. # Ex. # projects//locations/global/rolloutPlans/. - "predefinedRolloutPlan": "A String", # Optional. Predefined rollout plan. + "predefinedRolloutPlan": "A String", # Optional. Specifies the predefined rollout plan for the policy. Valid values + # are `SLOW_ROLLOUT` and `FAST_ROLLOUT`. The recommended value is + # `SLOW_ROLLOUT` for progressive rollout. For more information, see Rollout + # plans for global policies. "retryUuid": "A String", # Optional. The UUID that identifies a policy rollout retry attempt for update and # delete operations. Set this field only when retrying a rollout for an # existing extension policy. @@ -1545,6 +1630,12 @@

Method Details

# resource. There should be only one current rollout, but for # scalability, we make it repeated. { + "locationRolloutStatus": { # Output only. [Output Only] The rollout status for each location. The list of the + # locations is the same as the list of locations in the rollout plan. + "a_key": { + "state": "A String", # Output only. [Output Only] The state of the location rollout. + }, + }, "rollout": "A String", # Output only. [Output Only] The name of the rollout. # Ex. projects//locations/global/rollouts/. "rolloutPlan": "A String", # Output only. [Output Only] The name of the rollout plan. @@ -1555,6 +1646,12 @@

Method Details

], "previousRollout": { # Output only. [Output Only] The last completed rollout resource. This field will not # be populated until the first rollout is completed. + "locationRolloutStatus": { # Output only. [Output Only] The rollout status for each location. The list of the + # locations is the same as the list of locations in the rollout plan. + "a_key": { + "state": "A String", # Output only. [Output Only] The state of the location rollout. + }, + }, "rollout": "A String", # Output only. [Output Only] The name of the rollout. # Ex. projects//locations/global/rollouts/. "rolloutPlan": "A String", # Output only. [Output Only] The name of the rollout plan. @@ -1726,6 +1823,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.healthChecks.html b/docs/dyn/compute_beta.healthChecks.html index 0ebfbf7846..b99d5fcad1 100644 --- a/docs/dyn/compute_beta.healthChecks.html +++ b/docs/dyn/compute_beta.healthChecks.html @@ -817,6 +817,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1812,6 +1824,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2944,6 +2968,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3609,6 +3645,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.httpHealthChecks.html b/docs/dyn/compute_beta.httpHealthChecks.html index 0b21ccb72f..d2f3e34384 100644 --- a/docs/dyn/compute_beta.httpHealthChecks.html +++ b/docs/dyn/compute_beta.httpHealthChecks.html @@ -268,6 +268,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -645,6 +657,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1159,6 +1183,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1515,6 +1551,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.httpsHealthChecks.html b/docs/dyn/compute_beta.httpsHealthChecks.html index a4969a93e9..3f0556922f 100644 --- a/docs/dyn/compute_beta.httpsHealthChecks.html +++ b/docs/dyn/compute_beta.httpsHealthChecks.html @@ -268,6 +268,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -653,6 +665,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1175,6 +1199,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1535,6 +1571,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.images.html b/docs/dyn/compute_beta.images.html index 9c53b32783..7ee8a1d2c0 100644 --- a/docs/dyn/compute_beta.images.html +++ b/docs/dyn/compute_beta.images.html @@ -280,6 +280,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -608,6 +620,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2894,6 +2918,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -4401,6 +4437,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5561,6 +5609,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.instanceGroupManagerResizeRequests.html b/docs/dyn/compute_beta.instanceGroupManagerResizeRequests.html index 286321f02c..fd8baf43fb 100644 --- a/docs/dyn/compute_beta.instanceGroupManagerResizeRequests.html +++ b/docs/dyn/compute_beta.instanceGroupManagerResizeRequests.html @@ -265,6 +265,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -557,6 +569,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1515,6 +1539,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.instanceGroupManagers.html b/docs/dyn/compute_beta.instanceGroupManagers.html index 7a06f44ccf..930cfb9612 100644 --- a/docs/dyn/compute_beta.instanceGroupManagers.html +++ b/docs/dyn/compute_beta.instanceGroupManagers.html @@ -370,6 +370,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -713,6 +725,11 @@

Method Details

# on resize events (depending on the value set inupdatePolicy.instanceRedistributionType). "zones": [ # Zones where the regional managed instance group will create and manage # its instances. + # By default, a regional MIG doesn't automatically select an AI zone to create + # instances, even if an AI zone is available in the specified region. To + # create instances in an AI zone in the selected region, you must explicitly + # specify it in the distribution policy together with the other preferred + # zones. { "zone": "A String", # The URL of thezone. # The zone must exist in the region where the managed instance group is @@ -1382,6 +1399,117 @@

Method Details

"effective": True or False, # Output only. [Output Only] A bit indicating whether this configuration has # been applied to all managed instances in the group. }, + "appliedAcceleratorTopologies": [ # Output only. [Output Only] The accelerator topology applied to this MIG. + # Currently only one accelerator topology is supported. + { + "acceleratorTopology": "A String", # Output only. [Output Only] Topology in the format of: "16x16", "4x4x4", etc. + # The value is the same as configured in the WorkloadPolicy. + "state": "A String", # Output only. [Output Only] The state of the accelerator topology. + "stateDetails": { # Output only. [Output Only] The result of the latest accelerator topology state + # check. + "error": { # Output only. [Output Only] Encountered errors. + "errors": [ # [Output Only] The array of errors encountered while processing this + # operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error + # details. There is a set of defined message types to use for providing + # details.The syntax depends on the error code. For example, + # QuotaExceededInfo will have details when the error code is + # QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. + # + # Example of an error when contacting the "pubsub.googleapis.com" API when it + # is not enabled: + # + # { "reason": "API_DISABLED" + # "domain": "googleapis.com" + # "metadata": { + # "resource": "projects/123", + # "service": "pubsub.googleapis.com" + # } + # } + # + # This response indicates that the pubsub.googleapis.com API is not enabled. + # + # Example of an error that is returned when attempting to create a Spanner + # instance in a region that is out of stock: + # + # { "reason": "STOCKOUT" + # "domain": "spanner.googleapis.com", + # "metadata": { + # "availableRegions": "us-central1,us-east2" + # } + # } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain + # is typically the registered service name of the tool or product that + # generates the error. Example: "pubsub.googleapis.com". If the error is + # generated by some common infrastructure, the error domain must be a + # globally unique value that identifies the infrastructure. For Google API + # infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. + # + # Keys must match a regular expression of `a-z+` but should + # ideally be lowerCamelCase. Also, they must be limited to 64 characters in + # length. When identifying the current value of an exceeded limit, the units + # should be contained in the key, not the value. For example, rather than + # `{"instanceLimit": "100/request"}`, should be returned as, + # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of + # instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the + # proximate cause of the error. Error reasons are unique within a particular + # domain of errors. This should be at most 63 characters and match a + # regular expression of `A-Z+[A-Z0-9]`, which represents + # UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. + # + # For example, if a quota check failed with an error indicating the calling + # project hasn't enabled the accessed service, this can contain a URL pointing + # directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user + # which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at + # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + # Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota + # type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type + # or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, + }, + ], + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. + # This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. + }, + ], + }, + "timestamp": "A String", # Output only. [Output Only] Timestamp is shown only if there is an error. The field + # has // RFC3339 // + # text format. + }, + }, + ], "autoscaler": "A String", # Output only. [Output Only] The URL of theAutoscaler # that targets this instance group manager. "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. [Output Only] The status of bulk instance operation. @@ -2026,6 +2154,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2325,6 +2465,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2685,6 +2837,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2970,6 +3134,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3285,6 +3461,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3568,6 +3756,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3812,6 +4012,11 @@

Method Details

# on resize events (depending on the value set inupdatePolicy.instanceRedistributionType). "zones": [ # Zones where the regional managed instance group will create and manage # its instances. + # By default, a regional MIG doesn't automatically select an AI zone to create + # instances, even if an AI zone is available in the specified region. To + # create instances in an AI zone in the selected region, you must explicitly + # specify it in the distribution policy together with the other preferred + # zones. { "zone": "A String", # The URL of thezone. # The zone must exist in the region where the managed instance group is @@ -4481,6 +4686,117 @@

Method Details

"effective": True or False, # Output only. [Output Only] A bit indicating whether this configuration has # been applied to all managed instances in the group. }, + "appliedAcceleratorTopologies": [ # Output only. [Output Only] The accelerator topology applied to this MIG. + # Currently only one accelerator topology is supported. + { + "acceleratorTopology": "A String", # Output only. [Output Only] Topology in the format of: "16x16", "4x4x4", etc. + # The value is the same as configured in the WorkloadPolicy. + "state": "A String", # Output only. [Output Only] The state of the accelerator topology. + "stateDetails": { # Output only. [Output Only] The result of the latest accelerator topology state + # check. + "error": { # Output only. [Output Only] Encountered errors. + "errors": [ # [Output Only] The array of errors encountered while processing this + # operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error + # details. There is a set of defined message types to use for providing + # details.The syntax depends on the error code. For example, + # QuotaExceededInfo will have details when the error code is + # QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. + # + # Example of an error when contacting the "pubsub.googleapis.com" API when it + # is not enabled: + # + # { "reason": "API_DISABLED" + # "domain": "googleapis.com" + # "metadata": { + # "resource": "projects/123", + # "service": "pubsub.googleapis.com" + # } + # } + # + # This response indicates that the pubsub.googleapis.com API is not enabled. + # + # Example of an error that is returned when attempting to create a Spanner + # instance in a region that is out of stock: + # + # { "reason": "STOCKOUT" + # "domain": "spanner.googleapis.com", + # "metadata": { + # "availableRegions": "us-central1,us-east2" + # } + # } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain + # is typically the registered service name of the tool or product that + # generates the error. Example: "pubsub.googleapis.com". If the error is + # generated by some common infrastructure, the error domain must be a + # globally unique value that identifies the infrastructure. For Google API + # infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. + # + # Keys must match a regular expression of `a-z+` but should + # ideally be lowerCamelCase. Also, they must be limited to 64 characters in + # length. When identifying the current value of an exceeded limit, the units + # should be contained in the key, not the value. For example, rather than + # `{"instanceLimit": "100/request"}`, should be returned as, + # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of + # instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the + # proximate cause of the error. Error reasons are unique within a particular + # domain of errors. This should be at most 63 characters and match a + # regular expression of `A-Z+[A-Z0-9]`, which represents + # UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. + # + # For example, if a quota check failed with an error indicating the calling + # project hasn't enabled the accessed service, this can contain a URL pointing + # directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user + # which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at + # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + # Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota + # type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type + # or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, + }, + ], + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. + # This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. + }, + ], + }, + "timestamp": "A String", # Output only. [Output Only] Timestamp is shown only if there is an error. The field + # has // RFC3339 // + # text format. + }, + }, + ], "autoscaler": "A String", # Output only. [Output Only] The URL of theAutoscaler # that targets this instance group manager. "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. [Output Only] The status of bulk instance operation. @@ -5113,6 +5429,11 @@

Method Details

# on resize events (depending on the value set inupdatePolicy.instanceRedistributionType). "zones": [ # Zones where the regional managed instance group will create and manage # its instances. + # By default, a regional MIG doesn't automatically select an AI zone to create + # instances, even if an AI zone is available in the specified region. To + # create instances in an AI zone in the selected region, you must explicitly + # specify it in the distribution policy together with the other preferred + # zones. { "zone": "A String", # The URL of thezone. # The zone must exist in the region where the managed instance group is @@ -5782,6 +6103,117 @@

Method Details

"effective": True or False, # Output only. [Output Only] A bit indicating whether this configuration has # been applied to all managed instances in the group. }, + "appliedAcceleratorTopologies": [ # Output only. [Output Only] The accelerator topology applied to this MIG. + # Currently only one accelerator topology is supported. + { + "acceleratorTopology": "A String", # Output only. [Output Only] Topology in the format of: "16x16", "4x4x4", etc. + # The value is the same as configured in the WorkloadPolicy. + "state": "A String", # Output only. [Output Only] The state of the accelerator topology. + "stateDetails": { # Output only. [Output Only] The result of the latest accelerator topology state + # check. + "error": { # Output only. [Output Only] Encountered errors. + "errors": [ # [Output Only] The array of errors encountered while processing this + # operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error + # details. There is a set of defined message types to use for providing + # details.The syntax depends on the error code. For example, + # QuotaExceededInfo will have details when the error code is + # QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. + # + # Example of an error when contacting the "pubsub.googleapis.com" API when it + # is not enabled: + # + # { "reason": "API_DISABLED" + # "domain": "googleapis.com" + # "metadata": { + # "resource": "projects/123", + # "service": "pubsub.googleapis.com" + # } + # } + # + # This response indicates that the pubsub.googleapis.com API is not enabled. + # + # Example of an error that is returned when attempting to create a Spanner + # instance in a region that is out of stock: + # + # { "reason": "STOCKOUT" + # "domain": "spanner.googleapis.com", + # "metadata": { + # "availableRegions": "us-central1,us-east2" + # } + # } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain + # is typically the registered service name of the tool or product that + # generates the error. Example: "pubsub.googleapis.com". If the error is + # generated by some common infrastructure, the error domain must be a + # globally unique value that identifies the infrastructure. For Google API + # infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. + # + # Keys must match a regular expression of `a-z+` but should + # ideally be lowerCamelCase. Also, they must be limited to 64 characters in + # length. When identifying the current value of an exceeded limit, the units + # should be contained in the key, not the value. For example, rather than + # `{"instanceLimit": "100/request"}`, should be returned as, + # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of + # instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the + # proximate cause of the error. Error reasons are unique within a particular + # domain of errors. This should be at most 63 characters and match a + # regular expression of `A-Z+[A-Z0-9]`, which represents + # UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. + # + # For example, if a quota check failed with an error indicating the calling + # project hasn't enabled the accessed service, this can contain a URL pointing + # directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user + # which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at + # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + # Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota + # type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type + # or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, + }, + ], + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. + # This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. + }, + ], + }, + "timestamp": "A String", # Output only. [Output Only] Timestamp is shown only if there is an error. The field + # has // RFC3339 // + # text format. + }, + }, + ], "autoscaler": "A String", # Output only. [Output Only] The URL of theAutoscaler # that targets this instance group manager. "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. [Output Only] The status of bulk instance operation. @@ -6303,6 +6735,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6633,6 +7077,11 @@

Method Details

# on resize events (depending on the value set inupdatePolicy.instanceRedistributionType). "zones": [ # Zones where the regional managed instance group will create and manage # its instances. + # By default, a regional MIG doesn't automatically select an AI zone to create + # instances, even if an AI zone is available in the specified region. To + # create instances in an AI zone in the selected region, you must explicitly + # specify it in the distribution policy together with the other preferred + # zones. { "zone": "A String", # The URL of thezone. # The zone must exist in the region where the managed instance group is @@ -7302,6 +7751,117 @@

Method Details

"effective": True or False, # Output only. [Output Only] A bit indicating whether this configuration has # been applied to all managed instances in the group. }, + "appliedAcceleratorTopologies": [ # Output only. [Output Only] The accelerator topology applied to this MIG. + # Currently only one accelerator topology is supported. + { + "acceleratorTopology": "A String", # Output only. [Output Only] Topology in the format of: "16x16", "4x4x4", etc. + # The value is the same as configured in the WorkloadPolicy. + "state": "A String", # Output only. [Output Only] The state of the accelerator topology. + "stateDetails": { # Output only. [Output Only] The result of the latest accelerator topology state + # check. + "error": { # Output only. [Output Only] Encountered errors. + "errors": [ # [Output Only] The array of errors encountered while processing this + # operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error + # details. There is a set of defined message types to use for providing + # details.The syntax depends on the error code. For example, + # QuotaExceededInfo will have details when the error code is + # QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. + # + # Example of an error when contacting the "pubsub.googleapis.com" API when it + # is not enabled: + # + # { "reason": "API_DISABLED" + # "domain": "googleapis.com" + # "metadata": { + # "resource": "projects/123", + # "service": "pubsub.googleapis.com" + # } + # } + # + # This response indicates that the pubsub.googleapis.com API is not enabled. + # + # Example of an error that is returned when attempting to create a Spanner + # instance in a region that is out of stock: + # + # { "reason": "STOCKOUT" + # "domain": "spanner.googleapis.com", + # "metadata": { + # "availableRegions": "us-central1,us-east2" + # } + # } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain + # is typically the registered service name of the tool or product that + # generates the error. Example: "pubsub.googleapis.com". If the error is + # generated by some common infrastructure, the error domain must be a + # globally unique value that identifies the infrastructure. For Google API + # infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. + # + # Keys must match a regular expression of `a-z+` but should + # ideally be lowerCamelCase. Also, they must be limited to 64 characters in + # length. When identifying the current value of an exceeded limit, the units + # should be contained in the key, not the value. For example, rather than + # `{"instanceLimit": "100/request"}`, should be returned as, + # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of + # instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the + # proximate cause of the error. Error reasons are unique within a particular + # domain of errors. This should be at most 63 characters and match a + # regular expression of `A-Z+[A-Z0-9]`, which represents + # UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. + # + # For example, if a quota check failed with an error indicating the calling + # project hasn't enabled the accessed service, this can contain a URL pointing + # directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user + # which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at + # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + # Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota + # type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type + # or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, + }, + ], + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. + # This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. + }, + ], + }, + "timestamp": "A String", # Output only. [Output Only] Timestamp is shown only if there is an error. The field + # has // RFC3339 // + # text format. + }, + }, + ], "autoscaler": "A String", # Output only. [Output Only] The URL of theAutoscaler # that targets this instance group manager. "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. [Output Only] The status of bulk instance operation. @@ -9107,6 +9667,11 @@

Method Details

# on resize events (depending on the value set inupdatePolicy.instanceRedistributionType). "zones": [ # Zones where the regional managed instance group will create and manage # its instances. + # By default, a regional MIG doesn't automatically select an AI zone to create + # instances, even if an AI zone is available in the specified region. To + # create instances in an AI zone in the selected region, you must explicitly + # specify it in the distribution policy together with the other preferred + # zones. { "zone": "A String", # The URL of thezone. # The zone must exist in the region where the managed instance group is @@ -9776,6 +10341,117 @@

Method Details

"effective": True or False, # Output only. [Output Only] A bit indicating whether this configuration has # been applied to all managed instances in the group. }, + "appliedAcceleratorTopologies": [ # Output only. [Output Only] The accelerator topology applied to this MIG. + # Currently only one accelerator topology is supported. + { + "acceleratorTopology": "A String", # Output only. [Output Only] Topology in the format of: "16x16", "4x4x4", etc. + # The value is the same as configured in the WorkloadPolicy. + "state": "A String", # Output only. [Output Only] The state of the accelerator topology. + "stateDetails": { # Output only. [Output Only] The result of the latest accelerator topology state + # check. + "error": { # Output only. [Output Only] Encountered errors. + "errors": [ # [Output Only] The array of errors encountered while processing this + # operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error + # details. There is a set of defined message types to use for providing + # details.The syntax depends on the error code. For example, + # QuotaExceededInfo will have details when the error code is + # QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. + # + # Example of an error when contacting the "pubsub.googleapis.com" API when it + # is not enabled: + # + # { "reason": "API_DISABLED" + # "domain": "googleapis.com" + # "metadata": { + # "resource": "projects/123", + # "service": "pubsub.googleapis.com" + # } + # } + # + # This response indicates that the pubsub.googleapis.com API is not enabled. + # + # Example of an error that is returned when attempting to create a Spanner + # instance in a region that is out of stock: + # + # { "reason": "STOCKOUT" + # "domain": "spanner.googleapis.com", + # "metadata": { + # "availableRegions": "us-central1,us-east2" + # } + # } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain + # is typically the registered service name of the tool or product that + # generates the error. Example: "pubsub.googleapis.com". If the error is + # generated by some common infrastructure, the error domain must be a + # globally unique value that identifies the infrastructure. For Google API + # infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. + # + # Keys must match a regular expression of `a-z+` but should + # ideally be lowerCamelCase. Also, they must be limited to 64 characters in + # length. When identifying the current value of an exceeded limit, the units + # should be contained in the key, not the value. For example, rather than + # `{"instanceLimit": "100/request"}`, should be returned as, + # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of + # instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the + # proximate cause of the error. Error reasons are unique within a particular + # domain of errors. This should be at most 63 characters and match a + # regular expression of `A-Z+[A-Z0-9]`, which represents + # UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. + # + # For example, if a quota check failed with an error indicating the calling + # project hasn't enabled the accessed service, this can contain a URL pointing + # directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user + # which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at + # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + # Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota + # type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type + # or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, + }, + ], + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. + # This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. + }, + ], + }, + "timestamp": "A String", # Output only. [Output Only] Timestamp is shown only if there is an error. The field + # has // RFC3339 // + # text format. + }, + }, + ], "autoscaler": "A String", # Output only. [Output Only] The URL of theAutoscaler # that targets this instance group manager. "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. [Output Only] The status of bulk instance operation. @@ -10297,6 +10973,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -10658,6 +11346,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -10962,6 +11662,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -11269,6 +11981,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -11594,6 +12318,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -11901,6 +12637,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -12204,6 +12952,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -12498,6 +13258,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -12803,6 +13575,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -13110,6 +13894,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -13428,6 +14224,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -13746,6 +14554,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -14030,6 +14850,11 @@

Method Details

# on resize events (depending on the value set inupdatePolicy.instanceRedistributionType). "zones": [ # Zones where the regional managed instance group will create and manage # its instances. + # By default, a regional MIG doesn't automatically select an AI zone to create + # instances, even if an AI zone is available in the specified region. To + # create instances in an AI zone in the selected region, you must explicitly + # specify it in the distribution policy together with the other preferred + # zones. { "zone": "A String", # The URL of thezone. # The zone must exist in the region where the managed instance group is @@ -14699,6 +15524,117 @@

Method Details

"effective": True or False, # Output only. [Output Only] A bit indicating whether this configuration has # been applied to all managed instances in the group. }, + "appliedAcceleratorTopologies": [ # Output only. [Output Only] The accelerator topology applied to this MIG. + # Currently only one accelerator topology is supported. + { + "acceleratorTopology": "A String", # Output only. [Output Only] Topology in the format of: "16x16", "4x4x4", etc. + # The value is the same as configured in the WorkloadPolicy. + "state": "A String", # Output only. [Output Only] The state of the accelerator topology. + "stateDetails": { # Output only. [Output Only] The result of the latest accelerator topology state + # check. + "error": { # Output only. [Output Only] Encountered errors. + "errors": [ # [Output Only] The array of errors encountered while processing this + # operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error + # details. There is a set of defined message types to use for providing + # details.The syntax depends on the error code. For example, + # QuotaExceededInfo will have details when the error code is + # QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. + # + # Example of an error when contacting the "pubsub.googleapis.com" API when it + # is not enabled: + # + # { "reason": "API_DISABLED" + # "domain": "googleapis.com" + # "metadata": { + # "resource": "projects/123", + # "service": "pubsub.googleapis.com" + # } + # } + # + # This response indicates that the pubsub.googleapis.com API is not enabled. + # + # Example of an error that is returned when attempting to create a Spanner + # instance in a region that is out of stock: + # + # { "reason": "STOCKOUT" + # "domain": "spanner.googleapis.com", + # "metadata": { + # "availableRegions": "us-central1,us-east2" + # } + # } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain + # is typically the registered service name of the tool or product that + # generates the error. Example: "pubsub.googleapis.com". If the error is + # generated by some common infrastructure, the error domain must be a + # globally unique value that identifies the infrastructure. For Google API + # infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. + # + # Keys must match a regular expression of `a-z+` but should + # ideally be lowerCamelCase. Also, they must be limited to 64 characters in + # length. When identifying the current value of an exceeded limit, the units + # should be contained in the key, not the value. For example, rather than + # `{"instanceLimit": "100/request"}`, should be returned as, + # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of + # instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the + # proximate cause of the error. Error reasons are unique within a particular + # domain of errors. This should be at most 63 characters and match a + # regular expression of `A-Z+[A-Z0-9]`, which represents + # UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. + # + # For example, if a quota check failed with an error indicating the calling + # project hasn't enabled the accessed service, this can contain a URL pointing + # directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user + # which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at + # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + # Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota + # type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type + # or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, + }, + ], + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. + # This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. + }, + ], + }, + "timestamp": "A String", # Output only. [Output Only] Timestamp is shown only if there is an error. The field + # has // RFC3339 // + # text format. + }, + }, + ], "autoscaler": "A String", # Output only. [Output Only] The URL of theAutoscaler # that targets this instance group manager. "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. [Output Only] The status of bulk instance operation. @@ -15220,6 +16156,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -15581,6 +16529,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.instanceGroups.html b/docs/dyn/compute_beta.instanceGroups.html index 2ffa62e10d..2c4a58f7cc 100644 --- a/docs/dyn/compute_beta.instanceGroups.html +++ b/docs/dyn/compute_beta.instanceGroups.html @@ -295,6 +295,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -841,6 +853,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1269,6 +1293,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1964,6 +2000,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2265,6 +2313,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.instanceSettings.html b/docs/dyn/compute_beta.instanceSettings.html index d077ce9735..6178c7b006 100644 --- a/docs/dyn/compute_beta.instanceSettings.html +++ b/docs/dyn/compute_beta.instanceSettings.html @@ -326,6 +326,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.instanceTemplates.html b/docs/dyn/compute_beta.instanceTemplates.html index 8f051ea9ed..06940bcebe 100644 --- a/docs/dyn/compute_beta.instanceTemplates.html +++ b/docs/dyn/compute_beta.instanceTemplates.html @@ -1516,6 +1516,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -4285,6 +4297,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.instances.html b/docs/dyn/compute_beta.instances.html index dc4f8475a2..7369aff623 100644 --- a/docs/dyn/compute_beta.instances.html +++ b/docs/dyn/compute_beta.instances.html @@ -237,7 +237,7 @@

Instance Methods

testIamPermissions(project, zone, resource, body=None, x__xgafv=None)

Returns permissions that a caller has on the specified resource.

- update(project, zone, instance, body=None, minimalAction=None, mostDisruptiveAllowedAction=None, requestId=None, x__xgafv=None)

+ update(project, zone, instance, body=None, discardLocalSsd=None, minimalAction=None, mostDisruptiveAllowedAction=None, requestId=None, x__xgafv=None)

Updates an instance only if the necessary resources are available. This

updateAccessConfig(project, zone, instance, networkInterface, body=None, requestId=None, x__xgafv=None)

@@ -466,6 +466,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -929,6 +941,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1221,6 +1245,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3444,6 +3480,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5287,6 +5335,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5575,6 +5635,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5858,6 +5930,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6145,6 +6229,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6428,6 +6524,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -10910,6 +11018,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -12796,6 +12916,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -13077,6 +13209,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -13367,6 +13511,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -13661,6 +13817,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -13944,6 +14112,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -14359,6 +14539,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -14656,6 +14848,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -14940,6 +15144,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -16109,6 +16325,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -16409,6 +16637,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -16699,6 +16939,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -17012,6 +17264,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -17303,6 +17567,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -17593,6 +17869,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -18001,6 +18289,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -18299,6 +18599,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -18592,6 +18904,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -18885,6 +19209,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -19178,6 +19514,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -19478,6 +19826,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -19762,6 +20122,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -20045,6 +20417,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -20404,6 +20788,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -20694,6 +21090,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -20985,6 +21393,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -21139,7 +21559,7 @@

Method Details

- update(project, zone, instance, body=None, minimalAction=None, mostDisruptiveAllowedAction=None, requestId=None, x__xgafv=None) + update(project, zone, instance, body=None, discardLocalSsd=None, minimalAction=None, mostDisruptiveAllowedAction=None, requestId=None, x__xgafv=None)
Updates an instance only if the necessary resources are available. This
 method can update only a specific set of instance properties. See
 Updating a running instance for a list of updatable instance
@@ -22410,6 +22830,8 @@ 

Method Details

# not settable as a field in the request body. } + discardLocalSsd: boolean, Whether to discard local SSDs from the instance during restart +default value is false. minimalAction: string, Specifies the action to take when updating an instance even if the updated properties do not require it. If not specified, then Compute Engine acts based on the minimum action that the updated @@ -22583,6 +23005,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -22916,6 +23350,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -23207,6 +23653,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -23675,6 +24133,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -23971,6 +24441,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -24264,6 +24746,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.instantSnapshotGroups.html b/docs/dyn/compute_beta.instantSnapshotGroups.html index f7c3e967be..c0e6a1d5b4 100644 --- a/docs/dyn/compute_beta.instantSnapshotGroups.html +++ b/docs/dyn/compute_beta.instantSnapshotGroups.html @@ -269,6 +269,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1015,6 +1027,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.instantSnapshots.html b/docs/dyn/compute_beta.instantSnapshots.html index 201d455e80..4b244c148c 100644 --- a/docs/dyn/compute_beta.instantSnapshots.html +++ b/docs/dyn/compute_beta.instantSnapshots.html @@ -575,6 +575,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1434,6 +1446,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2853,6 +2877,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.interconnectAttachmentGroups.html b/docs/dyn/compute_beta.interconnectAttachmentGroups.html index 8b4ac7fffe..ba310e469c 100644 --- a/docs/dyn/compute_beta.interconnectAttachmentGroups.html +++ b/docs/dyn/compute_beta.interconnectAttachmentGroups.html @@ -275,6 +275,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1292,6 +1304,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1963,6 +1987,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.interconnectAttachments.html b/docs/dyn/compute_beta.interconnectAttachments.html index 63535c27b6..10024e19d7 100644 --- a/docs/dyn/compute_beta.interconnectAttachments.html +++ b/docs/dyn/compute_beta.interconnectAttachments.html @@ -848,6 +848,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1906,6 +1918,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3102,6 +3126,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3400,6 +3436,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.interconnectGroups.html b/docs/dyn/compute_beta.interconnectGroups.html index 849db11cc9..e80452d6b7 100644 --- a/docs/dyn/compute_beta.interconnectGroups.html +++ b/docs/dyn/compute_beta.interconnectGroups.html @@ -399,6 +399,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -680,6 +692,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1769,6 +1793,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2427,6 +2463,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.interconnects.html b/docs/dyn/compute_beta.interconnects.html index 3afa952e17..ea8d32c321 100644 --- a/docs/dyn/compute_beta.interconnects.html +++ b/docs/dyn/compute_beta.interconnects.html @@ -274,6 +274,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1285,6 +1297,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2278,6 +2302,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2565,6 +2601,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.licenses.html b/docs/dyn/compute_beta.licenses.html index ec17491f8b..f2c37e2ff8 100644 --- a/docs/dyn/compute_beta.licenses.html +++ b/docs/dyn/compute_beta.licenses.html @@ -274,6 +274,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1111,6 +1123,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2629,6 +2653,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.machineImages.html b/docs/dyn/compute_beta.machineImages.html index b87704a6eb..15852d2bc3 100644 --- a/docs/dyn/compute_beta.machineImages.html +++ b/docs/dyn/compute_beta.machineImages.html @@ -272,6 +272,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -4323,6 +4335,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -7323,6 +7347,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.networkAttachments.html b/docs/dyn/compute_beta.networkAttachments.html index 23f05f6ff9..892640b9fe 100644 --- a/docs/dyn/compute_beta.networkAttachments.html +++ b/docs/dyn/compute_beta.networkAttachments.html @@ -536,6 +536,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1337,6 +1349,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1905,6 +1929,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.networkEdgeSecurityServices.html b/docs/dyn/compute_beta.networkEdgeSecurityServices.html index 7ad77b55e8..3dc3c26cda 100644 --- a/docs/dyn/compute_beta.networkEdgeSecurityServices.html +++ b/docs/dyn/compute_beta.networkEdgeSecurityServices.html @@ -493,6 +493,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -861,6 +873,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1180,6 +1204,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.networkEndpointGroups.html b/docs/dyn/compute_beta.networkEndpointGroups.html index 72f614dc57..b865077b3e 100644 --- a/docs/dyn/compute_beta.networkEndpointGroups.html +++ b/docs/dyn/compute_beta.networkEndpointGroups.html @@ -735,6 +735,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1026,6 +1038,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1354,6 +1378,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2106,6 +2142,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.networkFirewallPolicies.html b/docs/dyn/compute_beta.networkFirewallPolicies.html index 4ef8db7905..1d64ca94c9 100644 --- a/docs/dyn/compute_beta.networkFirewallPolicies.html +++ b/docs/dyn/compute_beta.networkFirewallPolicies.html @@ -329,6 +329,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -802,6 +814,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1275,6 +1299,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2212,6 +2248,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2497,6 +2545,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -4520,6 +4580,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5869,6 +5941,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6339,6 +6423,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6809,6 +6905,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -7090,6 +7198,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -7371,6 +7491,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -7652,6 +7784,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.networks.html b/docs/dyn/compute_beta.networks.html index 0879ba7c3d..3138274757 100644 --- a/docs/dyn/compute_beta.networks.html +++ b/docs/dyn/compute_beta.networks.html @@ -379,6 +379,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -668,6 +680,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -953,6 +977,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2660,6 +2696,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3622,6 +3670,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3909,6 +3969,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -4197,6 +4269,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -4477,6 +4561,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -4867,6 +4963,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.nodeGroups.html b/docs/dyn/compute_beta.nodeGroups.html index a77d04f5d2..0abd39842e 100644 --- a/docs/dyn/compute_beta.nodeGroups.html +++ b/docs/dyn/compute_beta.nodeGroups.html @@ -301,6 +301,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -867,6 +879,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1157,6 +1181,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1999,6 +2035,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2836,6 +2884,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3127,6 +3187,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -4291,6 +4363,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -4582,6 +4666,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.nodeTemplates.html b/docs/dyn/compute_beta.nodeTemplates.html index c7fa073ad3..91f6e8a385 100644 --- a/docs/dyn/compute_beta.nodeTemplates.html +++ b/docs/dyn/compute_beta.nodeTemplates.html @@ -543,6 +543,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1359,6 +1371,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.organizationSecurityPolicies.html b/docs/dyn/compute_beta.organizationSecurityPolicies.html index b537d856b8..2d2a4302ae 100644 --- a/docs/dyn/compute_beta.organizationSecurityPolicies.html +++ b/docs/dyn/compute_beta.organizationSecurityPolicies.html @@ -318,6 +318,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1071,6 +1083,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1361,6 +1385,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1644,6 +1680,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1876,20 +1924,20 @@

Method Details

"ddosProtectionConfig": { "ddosAdaptiveProtection": "A String", "ddosImpactedBaselineThreshold": 3.14, # DDoS Protection for Network Load Balancers (and VMs with public IPs) - # builds DDos mitigations that minimize collateral damage. It quantifies + # builds DDoS mitigations that minimize collateral damage. It quantifies # this as the fraction of a non-abuse baseline that's inadvertently # blocked. # # Rules whose collateral damage exceeds ddosImpactedBaselineThreshold will # not be deployed. Using a lower value will prioritize keeping collateral # damage low, possibly at the cost of its effectiveness in rate limiting - # some or all of the attack. It should typically be unset, so Advanced DDos + # some or all of the attack. It should typically be unset, so Advanced DDoS # (and Adaptive Protection) uses the best mitigation it can find. Setting # the threshold is advised if there are logs for false positive detections - # with high collateral damage, and will cause Advanced DDos to attempt to - # find a less aggressive rule that satisfies the constraint; Failing that, - # it will fall back to no mitigation (smaller attack) or to broader network - # throttles (larger attack). + # with high collateral damage, and will cause Advanced DDoS to attempt to + # find a less aggressive rule that satisfies the constraint. If a suitable + # rule cannot be found, the system falls back to either no mitigation for + # smaller attacks or broader network throttles for larger ones. "ddosProtection": "A String", }, "description": "A String", # An optional description of this resource. Provide this property when you @@ -3126,20 +3174,20 @@

Method Details

"ddosProtectionConfig": { "ddosAdaptiveProtection": "A String", "ddosImpactedBaselineThreshold": 3.14, # DDoS Protection for Network Load Balancers (and VMs with public IPs) - # builds DDos mitigations that minimize collateral damage. It quantifies + # builds DDoS mitigations that minimize collateral damage. It quantifies # this as the fraction of a non-abuse baseline that's inadvertently # blocked. # # Rules whose collateral damage exceeds ddosImpactedBaselineThreshold will # not be deployed. Using a lower value will prioritize keeping collateral # damage low, possibly at the cost of its effectiveness in rate limiting - # some or all of the attack. It should typically be unset, so Advanced DDos + # some or all of the attack. It should typically be unset, so Advanced DDoS # (and Adaptive Protection) uses the best mitigation it can find. Setting # the threshold is advised if there are logs for false positive detections - # with high collateral damage, and will cause Advanced DDos to attempt to - # find a less aggressive rule that satisfies the constraint; Failing that, - # it will fall back to no mitigation (smaller attack) or to broader network - # throttles (larger attack). + # with high collateral damage, and will cause Advanced DDoS to attempt to + # find a less aggressive rule that satisfies the constraint. If a suitable + # rule cannot be found, the system falls back to either no mitigation for + # smaller attacks or broader network throttles for larger ones. "ddosProtection": "A String", }, "description": "A String", # An optional description of this resource. Provide this property when you @@ -3902,6 +3950,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -4221,20 +4281,20 @@

Method Details

"ddosProtectionConfig": { "ddosAdaptiveProtection": "A String", "ddosImpactedBaselineThreshold": 3.14, # DDoS Protection for Network Load Balancers (and VMs with public IPs) - # builds DDos mitigations that minimize collateral damage. It quantifies + # builds DDoS mitigations that minimize collateral damage. It quantifies # this as the fraction of a non-abuse baseline that's inadvertently # blocked. # # Rules whose collateral damage exceeds ddosImpactedBaselineThreshold will # not be deployed. Using a lower value will prioritize keeping collateral # damage low, possibly at the cost of its effectiveness in rate limiting - # some or all of the attack. It should typically be unset, so Advanced DDos + # some or all of the attack. It should typically be unset, so Advanced DDoS # (and Adaptive Protection) uses the best mitigation it can find. Setting # the threshold is advised if there are logs for false positive detections - # with high collateral damage, and will cause Advanced DDos to attempt to - # find a less aggressive rule that satisfies the constraint; Failing that, - # it will fall back to no mitigation (smaller attack) or to broader network - # throttles (larger attack). + # with high collateral damage, and will cause Advanced DDoS to attempt to + # find a less aggressive rule that satisfies the constraint. If a suitable + # rule cannot be found, the system falls back to either no mitigation for + # smaller attacks or broader network throttles for larger ones. "ddosProtection": "A String", }, "description": "A String", # An optional description of this resource. Provide this property when you @@ -5229,6 +5289,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5456,20 +5528,20 @@

Method Details

"ddosProtectionConfig": { "ddosAdaptiveProtection": "A String", "ddosImpactedBaselineThreshold": 3.14, # DDoS Protection for Network Load Balancers (and VMs with public IPs) - # builds DDos mitigations that minimize collateral damage. It quantifies + # builds DDoS mitigations that minimize collateral damage. It quantifies # this as the fraction of a non-abuse baseline that's inadvertently # blocked. # # Rules whose collateral damage exceeds ddosImpactedBaselineThreshold will # not be deployed. Using a lower value will prioritize keeping collateral # damage low, possibly at the cost of its effectiveness in rate limiting - # some or all of the attack. It should typically be unset, so Advanced DDos + # some or all of the attack. It should typically be unset, so Advanced DDoS # (and Adaptive Protection) uses the best mitigation it can find. Setting # the threshold is advised if there are logs for false positive detections - # with high collateral damage, and will cause Advanced DDos to attempt to - # find a less aggressive rule that satisfies the constraint; Failing that, - # it will fall back to no mitigation (smaller attack) or to broader network - # throttles (larger attack). + # with high collateral damage, and will cause Advanced DDoS to attempt to + # find a less aggressive rule that satisfies the constraint. If a suitable + # rule cannot be found, the system falls back to either no mitigation for + # smaller attacks or broader network throttles for larger ones. "ddosProtection": "A String", }, "description": "A String", # An optional description of this resource. Provide this property when you @@ -6230,6 +6302,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6986,6 +7070,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -7271,6 +7367,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -7556,6 +7664,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.packetMirrorings.html b/docs/dyn/compute_beta.packetMirrorings.html index a837c46253..566674ec65 100644 --- a/docs/dyn/compute_beta.packetMirrorings.html +++ b/docs/dyn/compute_beta.packetMirrorings.html @@ -569,6 +569,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1076,6 +1088,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1721,6 +1745,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.previewFeatures.html b/docs/dyn/compute_beta.previewFeatures.html index bb14f815e3..fa2ac6e858 100644 --- a/docs/dyn/compute_beta.previewFeatures.html +++ b/docs/dyn/compute_beta.previewFeatures.html @@ -597,6 +597,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.projects.html b/docs/dyn/compute_beta.projects.html index 8bc19caee0..6ad4de78c9 100644 --- a/docs/dyn/compute_beta.projects.html +++ b/docs/dyn/compute_beta.projects.html @@ -294,6 +294,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -586,6 +598,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -865,6 +889,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1158,6 +1194,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2062,6 +2110,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2365,6 +2425,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2654,6 +2726,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2965,6 +3049,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3253,6 +3349,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3542,6 +3650,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3838,6 +3958,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.publicAdvertisedPrefixes.html b/docs/dyn/compute_beta.publicAdvertisedPrefixes.html index 1d220917ec..e123d52a48 100644 --- a/docs/dyn/compute_beta.publicAdvertisedPrefixes.html +++ b/docs/dyn/compute_beta.publicAdvertisedPrefixes.html @@ -263,6 +263,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -548,6 +560,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -987,6 +1011,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1562,6 +1598,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1842,6 +1890,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.publicDelegatedPrefixes.html b/docs/dyn/compute_beta.publicDelegatedPrefixes.html index fb7de1f494..9f13f324ef 100644 --- a/docs/dyn/compute_beta.publicDelegatedPrefixes.html +++ b/docs/dyn/compute_beta.publicDelegatedPrefixes.html @@ -550,6 +550,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -836,6 +848,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1301,6 +1325,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1903,6 +1939,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2185,6 +2233,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.regionAutoscalers.html b/docs/dyn/compute_beta.regionAutoscalers.html index a8e2d3a949..5cee744b0a 100644 --- a/docs/dyn/compute_beta.regionAutoscalers.html +++ b/docs/dyn/compute_beta.regionAutoscalers.html @@ -269,6 +269,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1288,6 +1300,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2444,6 +2468,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3122,6 +3158,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.regionBackendBuckets.html b/docs/dyn/compute_beta.regionBackendBuckets.html index aae45610e1..26acf21d60 100644 --- a/docs/dyn/compute_beta.regionBackendBuckets.html +++ b/docs/dyn/compute_beta.regionBackendBuckets.html @@ -282,6 +282,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1336,6 +1348,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2504,6 +2528,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.regionBackendServices.html b/docs/dyn/compute_beta.regionBackendServices.html index 75dcfec2a5..e021a9b39e 100644 --- a/docs/dyn/compute_beta.regionBackendServices.html +++ b/docs/dyn/compute_beta.regionBackendServices.html @@ -287,6 +287,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -903,6 +915,10 @@

Method Details

"dynamicForwarding": { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the # backend service with dynamic forwarding feature which together with Service # Extension allows customized and complex routing logic. + "forwardProxy": { # Defines Dynamic Forwarding Proxy configuration. # Dynamic Forwarding Proxy configuration. + "enabled": True or False, # A boolean flag enabling dynamic forwarding proxy. + "proxyMode": "A String", # Determines the dynamic forwarding proxy mode. + }, "ipPortSelection": { # Defines a IP:PORT based dynamic forwarding configuration for the backend # IP:PORT based dynamic forwarding configuration. # service. Some ranges are restricted: Restricted # ranges. @@ -961,7 +977,7 @@

Method Details

# draining traffic. A setting of false allows existing TCP # connections to persist, even on VMs no longer in the active pool, for up # to the duration of the connection draining timeout (10 minutes). - "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol isTCP. + "disableConnectionDrainOnFailover": True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. # # The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the @@ -2676,6 +2692,10 @@

Method Details

"dynamicForwarding": { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the # backend service with dynamic forwarding feature which together with Service # Extension allows customized and complex routing logic. + "forwardProxy": { # Defines Dynamic Forwarding Proxy configuration. # Dynamic Forwarding Proxy configuration. + "enabled": True or False, # A boolean flag enabling dynamic forwarding proxy. + "proxyMode": "A String", # Determines the dynamic forwarding proxy mode. + }, "ipPortSelection": { # Defines a IP:PORT based dynamic forwarding configuration for the backend # IP:PORT based dynamic forwarding configuration. # service. Some ranges are restricted: Restricted # ranges. @@ -2734,7 +2754,7 @@

Method Details

# draining traffic. A setting of false allows existing TCP # connections to persist, even on VMs no longer in the active pool, for up # to the duration of the connection draining timeout (10 minutes). - "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol isTCP. + "disableConnectionDrainOnFailover": True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. # # The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the @@ -3684,6 +3704,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -4386,6 +4418,10 @@

Method Details

"dynamicForwarding": { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the # backend service with dynamic forwarding feature which together with Service # Extension allows customized and complex routing logic. + "forwardProxy": { # Defines Dynamic Forwarding Proxy configuration. # Dynamic Forwarding Proxy configuration. + "enabled": True or False, # A boolean flag enabling dynamic forwarding proxy. + "proxyMode": "A String", # Determines the dynamic forwarding proxy mode. + }, "ipPortSelection": { # Defines a IP:PORT based dynamic forwarding configuration for the backend # IP:PORT based dynamic forwarding configuration. # service. Some ranges are restricted: Restricted # ranges. @@ -4444,7 +4480,7 @@

Method Details

# draining traffic. A setting of false allows existing TCP # connections to persist, even on VMs no longer in the active pool, for up # to the duration of the connection draining timeout (10 minutes). - "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol isTCP. + "disableConnectionDrainOnFailover": True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. # # The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the @@ -5859,6 +5895,10 @@

Method Details

"dynamicForwarding": { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the # backend service with dynamic forwarding feature which together with Service # Extension allows customized and complex routing logic. + "forwardProxy": { # Defines Dynamic Forwarding Proxy configuration. # Dynamic Forwarding Proxy configuration. + "enabled": True or False, # A boolean flag enabling dynamic forwarding proxy. + "proxyMode": "A String", # Determines the dynamic forwarding proxy mode. + }, "ipPortSelection": { # Defines a IP:PORT based dynamic forwarding configuration for the backend # IP:PORT based dynamic forwarding configuration. # service. Some ranges are restricted: Restricted # ranges. @@ -5917,7 +5957,7 @@

Method Details

# draining traffic. A setting of false allows existing TCP # connections to persist, even on VMs no longer in the active pool, for up # to the duration of the connection draining timeout (10 minutes). - "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol isTCP. + "disableConnectionDrainOnFailover": True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. # # The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the @@ -7273,6 +7313,10 @@

Method Details

"dynamicForwarding": { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the # backend service with dynamic forwarding feature which together with Service # Extension allows customized and complex routing logic. + "forwardProxy": { # Defines Dynamic Forwarding Proxy configuration. # Dynamic Forwarding Proxy configuration. + "enabled": True or False, # A boolean flag enabling dynamic forwarding proxy. + "proxyMode": "A String", # Determines the dynamic forwarding proxy mode. + }, "ipPortSelection": { # Defines a IP:PORT based dynamic forwarding configuration for the backend # IP:PORT based dynamic forwarding configuration. # service. Some ranges are restricted: Restricted # ranges. @@ -7331,7 +7375,7 @@

Method Details

# draining traffic. A setting of false allows existing TCP # connections to persist, even on VMs no longer in the active pool, for up # to the duration of the connection draining timeout (10 minutes). - "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol isTCP. + "disableConnectionDrainOnFailover": True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. # # The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the @@ -8281,6 +8325,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -9447,6 +9503,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -10095,6 +10163,10 @@

Method Details

"dynamicForwarding": { # Defines a dynamic forwarding configuration for the backend service. # Dynamic forwarding configuration. This field is used to configure the # backend service with dynamic forwarding feature which together with Service # Extension allows customized and complex routing logic. + "forwardProxy": { # Defines Dynamic Forwarding Proxy configuration. # Dynamic Forwarding Proxy configuration. + "enabled": True or False, # A boolean flag enabling dynamic forwarding proxy. + "proxyMode": "A String", # Determines the dynamic forwarding proxy mode. + }, "ipPortSelection": { # Defines a IP:PORT based dynamic forwarding configuration for the backend # IP:PORT based dynamic forwarding configuration. # service. Some ranges are restricted: Restricted # ranges. @@ -10153,7 +10225,7 @@

Method Details

# draining traffic. A setting of false allows existing TCP # connections to persist, even on VMs no longer in the active pool, for up # to the duration of the connection draining timeout (10 minutes). - "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol isTCP. + "disableConnectionDrainOnFailover": True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. # # The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the @@ -11103,6 +11175,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.regionCommitments.html b/docs/dyn/compute_beta.regionCommitments.html index ce950f7c82..35e04f793c 100644 --- a/docs/dyn/compute_beta.regionCommitments.html +++ b/docs/dyn/compute_beta.regionCommitments.html @@ -1600,6 +1600,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2816,6 +2828,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3346,6 +3370,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.regionCompositeHealthChecks.html b/docs/dyn/compute_beta.regionCompositeHealthChecks.html index c451b52d0f..699aaa5da4 100644 --- a/docs/dyn/compute_beta.regionCompositeHealthChecks.html +++ b/docs/dyn/compute_beta.regionCompositeHealthChecks.html @@ -510,6 +510,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -897,6 +909,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1421,6 +1445,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.regionDiskSettings.html b/docs/dyn/compute_beta.regionDiskSettings.html index 657925b7e3..fbf53b8c9d 100644 --- a/docs/dyn/compute_beta.regionDiskSettings.html +++ b/docs/dyn/compute_beta.regionDiskSettings.html @@ -324,6 +324,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.regionDisks.html b/docs/dyn/compute_beta.regionDisks.html index 84a0363cbe..684ba20830 100644 --- a/docs/dyn/compute_beta.regionDisks.html +++ b/docs/dyn/compute_beta.regionDisks.html @@ -305,6 +305,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -632,6 +644,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1245,6 +1269,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1530,6 +1566,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3273,6 +3321,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -4251,6 +4311,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -4539,6 +4611,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5710,6 +5794,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6020,6 +6116,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6302,6 +6410,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6604,6 +6724,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -7461,6 +7593,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.regionHealthAggregationPolicies.html b/docs/dyn/compute_beta.regionHealthAggregationPolicies.html index b263251eb7..ecf3ce2e30 100644 --- a/docs/dyn/compute_beta.regionHealthAggregationPolicies.html +++ b/docs/dyn/compute_beta.regionHealthAggregationPolicies.html @@ -526,6 +526,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -945,6 +957,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1502,6 +1526,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.regionHealthCheckServices.html b/docs/dyn/compute_beta.regionHealthCheckServices.html index b275c4af42..3128b91953 100644 --- a/docs/dyn/compute_beta.regionHealthCheckServices.html +++ b/docs/dyn/compute_beta.regionHealthCheckServices.html @@ -74,6 +74,12 @@

Compute Engine API . regionHealthCheckServices

Instance Methods

+

+ aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)

+

Retrieves the list of all HealthCheckService resources,

+

+ aggregatedList_next()

+

Retrieves the next page of results.

close()

Close httplib2 connections.

@@ -99,6 +105,276 @@

Instance Methods

testIamPermissions(project, region, resource, body=None, x__xgafv=None)

Returns permissions that a caller has on the specified resource.

Method Details

+
+ aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None) +
Retrieves the list of all HealthCheckService resources,
+regional and global, available to the specified project.
+
+To prevent failure, it is recommended that you set the
+`returnPartialSuccess` parameter to `true`.
+
+Args:
+  project: string, Name of the project scoping this request. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most
+Compute resources support two types of filter expressions:
+expressions that support regular expressions and expressions that follow
+API improvement proposal AIP-160.
+These two types of filter expressions cannot be mixed in one request.
+
+If you want to use AIP-160, your expression must specify the field name, an
+operator, and the value that you want to use for filtering. The value
+must be a string, a number, or a boolean. The operator
+must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
+
+For example, if you are filtering Compute Engine instances, you can
+exclude instances named `example-instance` by specifying
+`name != example-instance`.
+
+The `:*` comparison can be used to test whether a key has been defined.
+For example, to find all objects with `owner` label use:
+```
+labels.owner:*
+```
+
+You can also filter nested fields. For example, you could specify
+`scheduling.automaticRestart = false` to include instances only
+if they are not scheduled for automatic restarts. You can use filtering
+on nested fields to filter based onresource labels.
+
+To filter on multiple expressions, provide each separate expression within
+parentheses. For example:
+```
+(scheduling.automaticRestart = true)
+(cpuPlatform = "Intel Skylake")
+```
+By default, each expression is an `AND` expression. However, you
+can include `AND` and `OR` expressions explicitly.
+For example:
+```
+(cpuPlatform = "Intel Skylake") OR
+(cpuPlatform = "Intel Broadwell") AND
+(scheduling.automaticRestart = true)
+```
+
+If you want to use a regular expression, use the `eq` (equal) or `ne`
+(not equal) operator against a single un-parenthesized expression with or
+without quotes or against multiple parenthesized expressions. Examples:
+
+`fieldname eq unquoted literal`
+`fieldname eq 'single quoted literal'`
+`fieldname eq "double quoted literal"`
+`(fieldname1 eq literal) (fieldname2 ne "literal")`
+
+The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
+The literal value must match the entire field.
+
+For example, to filter for instances that do not end with name "instance",
+you would use `name ne .*instance`.
+
+You cannot combine constraints on multiple fields using regular
+expressions.
+  includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
+global) should be included in the response. For new resource types added
+after this field, the flag has no effect as new resource types will always
+include every visible scope for each scope type in response. For resource
+types which predate this field, if this flag is omitted or false, only
+scopes of the scope types where the resource type is expected to be found
+will be included.
+  maxResults: integer, The maximum number of results per page that should be returned.
+If the number of available results is larger than `maxResults`,
+Compute Engine returns a `nextPageToken` that can be used to get
+the next page of results in subsequent list requests. Acceptable values are
+`0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results
+are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation
+timestamp using `orderBy="creationTimestamp desc"`. This sorts
+results based on the `creationTimestamp` field in
+reverse chronological order (newest result first). Use this to sort
+resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by `name` or
+`creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the
+`nextPageToken` returned by a previous list request to get
+the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
+of failure. The default value is false.
+
+For example, when partial success behavior is enabled, aggregatedList for a
+single zone scope either returns all resources in the zone or no resources,
+with an error code.
+  serviceProjectNumber: string, The Shared VPC service project id or service project number for which
+aggregated list request is invoked for subnetworks list-usable api.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Contains a list of HealthCheckServicesScopedList.
+  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+  "items": { # A list of HealthCheckServicesScopedList resources.
+    "a_key": { # Name of the scope containing this set of HealthCheckServices.
+      "resources": [ # A list of HealthCheckServices contained in this scope.
+        { # Represents a Health-Check as a Service resource.
+          "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+              # text format.
+          "description": "A String", # An optional description of this resource. Provide this property when you
+              # create the resource.
+          "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object.
+              # This field is used in optimistic locking. This field will be ignored when
+              # inserting a HealthCheckService. An up-to-date fingerprint must
+              # be provided in order to patch/update the HealthCheckService; Otherwise, the
+              # request will fail with error 412 conditionNotMet. To see the
+              # latest fingerprint, make a get() request to retrieve the
+              # HealthCheckService.
+          "healthChecks": [ # A list of URLs to the HealthCheck resources. Must have
+              # at least one HealthCheck, and not more than 10 for regionalHealthCheckService, and not more than 1 for globalHealthCheckService.HealthCheck resources must haveportSpecification=USE_SERVING_PORT orportSpecification=USE_FIXED_PORT. For
+              # regional HealthCheckService, theHealthCheck must be regional and in the same
+              # region. For global HealthCheckService,HealthCheck must be global. Mix of regional and globalHealthChecks is not supported. Multiple regionalHealthChecks must belong to the same region. RegionalHealthChecks must belong to the same region as zones ofNetworkEndpointGroups. For globalHealthCheckService using globalINTERNET_IP_PORT NetworkEndpointGroups, the
+              # global HealthChecks must specify sourceRegions,
+              # and HealthChecks that specify sourceRegions can
+              # only be used with global INTERNET_IP_PORTNetworkEndpointGroups.
+            "A String",
+          ],
+          "healthStatusAggregationPolicy": "A String", # Optional. Policy for how the results from multiple health checks
+              # for the same endpoint are aggregated. Defaults to NO_AGGREGATION
+              # if unspecified.
+              #
+              #    - NO_AGGREGATION. An EndpointHealth message is
+              #    returned for each  pair in the health check
+              #    service.
+              #    - AND. If any health check of an endpoint reportsUNHEALTHY, then UNHEALTHY is theHealthState of the endpoint. If all health checks reportHEALTHY, the HealthState of the endpoint isHEALTHY.
+              #
+              # .
+              # This is only allowed with regional HealthCheckService.
+          "healthStatusAggregationStrategy": "A String", # This field is deprecated. Use health_status_aggregation_policy
+              # instead.
+              #
+              # Policy for how the results from multiple health checks for the
+              # same endpoint are aggregated.
+              #
+              #    - NO_AGGREGATION. An EndpointHealth
+              #    message is returned for each backend in the health check
+              #    service.
+              #    - AND.  If any backend's health check reportsUNHEALTHY, then UNHEALTHY is theHealthState of the entire health check service. If
+              #    all backend's are healthy, the HealthState of the
+              #    health check service is HEALTHY.
+              #
+              # .
+          "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+              # defined by the server.
+          "kind": "compute#healthCheckService", # Output only. [Output only] Type of the resource. Alwayscompute#healthCheckServicefor health check services.
+          "name": "A String", # Name of the resource. The name must be 1-63 characters long, and comply
+              # with RFC1035. Specifically, the name must be 1-63 characters
+              # long and match the regular expression
+              # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character
+              # must be a lowercase letter, and all following characters must be a dash,
+              # lowercase letter, or digit, except the last character, which cannot be a
+              # dash.
+          "networkEndpointGroups": [ # A list of URLs to the NetworkEndpointGroup
+              # resources. Must not have more than 100.  For regionalHealthCheckService, NEGs must be in
+              # zones in the region of the HealthCheckService. For globalHealthCheckServices, the NetworkEndpointGroups
+              # must be global INTERNET_IP_PORT.
+            "A String",
+          ],
+          "notificationEndpoints": [ # A list of URLs to the NotificationEndpoint
+              # resources. Must not have more than 10.  A list of endpoints for
+              # receiving notifications of change in health status. For regionalHealthCheckService,NotificationEndpoint must be regional and in the
+              # same region. For global HealthCheckService,NotificationEndpoint must be global.
+            "A String",
+          ],
+          "region": "A String", # Output only. [Output Only] URL of the region where the health check service
+              # resides. This field is not applicable to global health check services.
+              # You must specify this field as part of the HTTP request URL. It is
+              # not settable as a field in the request body.
+          "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
+        },
+      ],
+      "warning": { # Informational warning which replaces the list of
+          # backend services when the list is empty.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+            # Engine returns NO_RESULTS_ON_PAGE if there
+            # are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key:
+            # value format. For example:
+            #
+            # "data": [
+            #   {
+            #    "key": "scope",
+            #    "value": "zones/us-east1-d"
+            #   }
+          {
+            "key": "A String", # [Output Only] A key that provides more detail on the warning being
+                # returned. For example, for warnings where there are no results in a list
+                # request for a particular zone, this key might be scope and
+                # the key value might be the zone name. Other examples might be a key
+                # indicating a deprecated resource and a suggested replacement, or a
+                # warning about invalid network settings (for example, if an instance
+                # attempts to perform IP forwarding but is not enabled for IP forwarding).
+            "value": "A String", # [Output Only] A warning data value corresponding to the key.
+          },
+        ],
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+      },
+    },
+  },
+  "kind": "compute#healthCheckServiceAggregatedList", # Output only. Type of resource.
+  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for
+      # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
+      # the query parameter pageToken in the next list request.
+      # Subsequent list requests will have their own nextPageToken to
+      # continue paging through the results.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined URL for this resource.
+  "unreachables": [ # Output only. [Output Only] Unreachable resources.
+    "A String",
+  ],
+  "warning": { # [Output Only] Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+        # Engine returns NO_RESULTS_ON_PAGE if there
+        # are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key:
+        # value format. For example:
+        #
+        # "data": [
+        #   {
+        #    "key": "scope",
+        #    "value": "zones/us-east1-d"
+        #   }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being
+            # returned. For example, for warnings where there are no results in a list
+            # request for a particular zone, this key might be scope and
+            # the key value might be the zone name. Other examples might be a key
+            # indicating a deprecated resource and a suggested replacement, or a
+            # warning about invalid network settings (for example, if an instance
+            # attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ aggregatedList_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.
+        
+
+
close()
Close httplib2 connections.
@@ -267,6 +543,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -719,6 +1007,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1309,6 +1609,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.regionHealthChecks.html b/docs/dyn/compute_beta.regionHealthChecks.html index cb7f7ba1a9..b5cd3ab5ea 100644 --- a/docs/dyn/compute_beta.regionHealthChecks.html +++ b/docs/dyn/compute_beta.regionHealthChecks.html @@ -269,6 +269,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1266,6 +1278,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2400,6 +2424,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3067,6 +3103,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.regionHealthSources.html b/docs/dyn/compute_beta.regionHealthSources.html index b31368fef1..e05f62653f 100644 --- a/docs/dyn/compute_beta.regionHealthSources.html +++ b/docs/dyn/compute_beta.regionHealthSources.html @@ -513,6 +513,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -906,6 +918,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1436,6 +1460,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.regionInstanceGroupManagerResizeRequests.html b/docs/dyn/compute_beta.regionInstanceGroupManagerResizeRequests.html index 83931c2983..5dff5a402f 100644 --- a/docs/dyn/compute_beta.regionInstanceGroupManagerResizeRequests.html +++ b/docs/dyn/compute_beta.regionInstanceGroupManagerResizeRequests.html @@ -265,6 +265,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -557,6 +569,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1513,6 +1537,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.regionInstanceGroupManagers.html b/docs/dyn/compute_beta.regionInstanceGroupManagers.html index d64f02ba11..f80b90e210 100644 --- a/docs/dyn/compute_beta.regionInstanceGroupManagers.html +++ b/docs/dyn/compute_beta.regionInstanceGroupManagers.html @@ -360,6 +360,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -723,6 +735,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1036,6 +1060,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1403,6 +1439,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1685,6 +1733,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1997,6 +2057,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2276,6 +2348,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2519,6 +2603,11 @@

Method Details

# on resize events (depending on the value set inupdatePolicy.instanceRedistributionType). "zones": [ # Zones where the regional managed instance group will create and manage # its instances. + # By default, a regional MIG doesn't automatically select an AI zone to create + # instances, even if an AI zone is available in the specified region. To + # create instances in an AI zone in the selected region, you must explicitly + # specify it in the distribution policy together with the other preferred + # zones. { "zone": "A String", # The URL of thezone. # The zone must exist in the region where the managed instance group is @@ -3188,6 +3277,117 @@

Method Details

"effective": True or False, # Output only. [Output Only] A bit indicating whether this configuration has # been applied to all managed instances in the group. }, + "appliedAcceleratorTopologies": [ # Output only. [Output Only] The accelerator topology applied to this MIG. + # Currently only one accelerator topology is supported. + { + "acceleratorTopology": "A String", # Output only. [Output Only] Topology in the format of: "16x16", "4x4x4", etc. + # The value is the same as configured in the WorkloadPolicy. + "state": "A String", # Output only. [Output Only] The state of the accelerator topology. + "stateDetails": { # Output only. [Output Only] The result of the latest accelerator topology state + # check. + "error": { # Output only. [Output Only] Encountered errors. + "errors": [ # [Output Only] The array of errors encountered while processing this + # operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error + # details. There is a set of defined message types to use for providing + # details.The syntax depends on the error code. For example, + # QuotaExceededInfo will have details when the error code is + # QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. + # + # Example of an error when contacting the "pubsub.googleapis.com" API when it + # is not enabled: + # + # { "reason": "API_DISABLED" + # "domain": "googleapis.com" + # "metadata": { + # "resource": "projects/123", + # "service": "pubsub.googleapis.com" + # } + # } + # + # This response indicates that the pubsub.googleapis.com API is not enabled. + # + # Example of an error that is returned when attempting to create a Spanner + # instance in a region that is out of stock: + # + # { "reason": "STOCKOUT" + # "domain": "spanner.googleapis.com", + # "metadata": { + # "availableRegions": "us-central1,us-east2" + # } + # } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain + # is typically the registered service name of the tool or product that + # generates the error. Example: "pubsub.googleapis.com". If the error is + # generated by some common infrastructure, the error domain must be a + # globally unique value that identifies the infrastructure. For Google API + # infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. + # + # Keys must match a regular expression of `a-z+` but should + # ideally be lowerCamelCase. Also, they must be limited to 64 characters in + # length. When identifying the current value of an exceeded limit, the units + # should be contained in the key, not the value. For example, rather than + # `{"instanceLimit": "100/request"}`, should be returned as, + # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of + # instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the + # proximate cause of the error. Error reasons are unique within a particular + # domain of errors. This should be at most 63 characters and match a + # regular expression of `A-Z+[A-Z0-9]`, which represents + # UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. + # + # For example, if a quota check failed with an error indicating the calling + # project hasn't enabled the accessed service, this can contain a URL pointing + # directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user + # which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at + # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + # Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota + # type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type + # or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, + }, + ], + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. + # This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. + }, + ], + }, + "timestamp": "A String", # Output only. [Output Only] Timestamp is shown only if there is an error. The field + # has // RFC3339 // + # text format. + }, + }, + ], "autoscaler": "A String", # Output only. [Output Only] The URL of theAutoscaler # that targets this instance group manager. "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. [Output Only] The status of bulk instance operation. @@ -3682,6 +3882,11 @@

Method Details

# on resize events (depending on the value set inupdatePolicy.instanceRedistributionType). "zones": [ # Zones where the regional managed instance group will create and manage # its instances. + # By default, a regional MIG doesn't automatically select an AI zone to create + # instances, even if an AI zone is available in the specified region. To + # create instances in an AI zone in the selected region, you must explicitly + # specify it in the distribution policy together with the other preferred + # zones. { "zone": "A String", # The URL of thezone. # The zone must exist in the region where the managed instance group is @@ -4351,6 +4556,117 @@

Method Details

"effective": True or False, # Output only. [Output Only] A bit indicating whether this configuration has # been applied to all managed instances in the group. }, + "appliedAcceleratorTopologies": [ # Output only. [Output Only] The accelerator topology applied to this MIG. + # Currently only one accelerator topology is supported. + { + "acceleratorTopology": "A String", # Output only. [Output Only] Topology in the format of: "16x16", "4x4x4", etc. + # The value is the same as configured in the WorkloadPolicy. + "state": "A String", # Output only. [Output Only] The state of the accelerator topology. + "stateDetails": { # Output only. [Output Only] The result of the latest accelerator topology state + # check. + "error": { # Output only. [Output Only] Encountered errors. + "errors": [ # [Output Only] The array of errors encountered while processing this + # operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error + # details. There is a set of defined message types to use for providing + # details.The syntax depends on the error code. For example, + # QuotaExceededInfo will have details when the error code is + # QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. + # + # Example of an error when contacting the "pubsub.googleapis.com" API when it + # is not enabled: + # + # { "reason": "API_DISABLED" + # "domain": "googleapis.com" + # "metadata": { + # "resource": "projects/123", + # "service": "pubsub.googleapis.com" + # } + # } + # + # This response indicates that the pubsub.googleapis.com API is not enabled. + # + # Example of an error that is returned when attempting to create a Spanner + # instance in a region that is out of stock: + # + # { "reason": "STOCKOUT" + # "domain": "spanner.googleapis.com", + # "metadata": { + # "availableRegions": "us-central1,us-east2" + # } + # } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain + # is typically the registered service name of the tool or product that + # generates the error. Example: "pubsub.googleapis.com". If the error is + # generated by some common infrastructure, the error domain must be a + # globally unique value that identifies the infrastructure. For Google API + # infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. + # + # Keys must match a regular expression of `a-z+` but should + # ideally be lowerCamelCase. Also, they must be limited to 64 characters in + # length. When identifying the current value of an exceeded limit, the units + # should be contained in the key, not the value. For example, rather than + # `{"instanceLimit": "100/request"}`, should be returned as, + # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of + # instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the + # proximate cause of the error. Error reasons are unique within a particular + # domain of errors. This should be at most 63 characters and match a + # regular expression of `A-Z+[A-Z0-9]`, which represents + # UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. + # + # For example, if a quota check failed with an error indicating the calling + # project hasn't enabled the accessed service, this can contain a URL pointing + # directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user + # which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at + # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + # Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota + # type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type + # or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, + }, + ], + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. + # This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. + }, + ], + }, + "timestamp": "A String", # Output only. [Output Only] Timestamp is shown only if there is an error. The field + # has // RFC3339 // + # text format. + }, + }, + ], "autoscaler": "A String", # Output only. [Output Only] The URL of theAutoscaler # that targets this instance group manager. "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. [Output Only] The status of bulk instance operation. @@ -4872,6 +5188,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5201,6 +5529,11 @@

Method Details

# on resize events (depending on the value set inupdatePolicy.instanceRedistributionType). "zones": [ # Zones where the regional managed instance group will create and manage # its instances. + # By default, a regional MIG doesn't automatically select an AI zone to create + # instances, even if an AI zone is available in the specified region. To + # create instances in an AI zone in the selected region, you must explicitly + # specify it in the distribution policy together with the other preferred + # zones. { "zone": "A String", # The URL of thezone. # The zone must exist in the region where the managed instance group is @@ -5870,6 +6203,117 @@

Method Details

"effective": True or False, # Output only. [Output Only] A bit indicating whether this configuration has # been applied to all managed instances in the group. }, + "appliedAcceleratorTopologies": [ # Output only. [Output Only] The accelerator topology applied to this MIG. + # Currently only one accelerator topology is supported. + { + "acceleratorTopology": "A String", # Output only. [Output Only] Topology in the format of: "16x16", "4x4x4", etc. + # The value is the same as configured in the WorkloadPolicy. + "state": "A String", # Output only. [Output Only] The state of the accelerator topology. + "stateDetails": { # Output only. [Output Only] The result of the latest accelerator topology state + # check. + "error": { # Output only. [Output Only] Encountered errors. + "errors": [ # [Output Only] The array of errors encountered while processing this + # operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error + # details. There is a set of defined message types to use for providing + # details.The syntax depends on the error code. For example, + # QuotaExceededInfo will have details when the error code is + # QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. + # + # Example of an error when contacting the "pubsub.googleapis.com" API when it + # is not enabled: + # + # { "reason": "API_DISABLED" + # "domain": "googleapis.com" + # "metadata": { + # "resource": "projects/123", + # "service": "pubsub.googleapis.com" + # } + # } + # + # This response indicates that the pubsub.googleapis.com API is not enabled. + # + # Example of an error that is returned when attempting to create a Spanner + # instance in a region that is out of stock: + # + # { "reason": "STOCKOUT" + # "domain": "spanner.googleapis.com", + # "metadata": { + # "availableRegions": "us-central1,us-east2" + # } + # } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain + # is typically the registered service name of the tool or product that + # generates the error. Example: "pubsub.googleapis.com". If the error is + # generated by some common infrastructure, the error domain must be a + # globally unique value that identifies the infrastructure. For Google API + # infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. + # + # Keys must match a regular expression of `a-z+` but should + # ideally be lowerCamelCase. Also, they must be limited to 64 characters in + # length. When identifying the current value of an exceeded limit, the units + # should be contained in the key, not the value. For example, rather than + # `{"instanceLimit": "100/request"}`, should be returned as, + # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of + # instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the + # proximate cause of the error. Error reasons are unique within a particular + # domain of errors. This should be at most 63 characters and match a + # regular expression of `A-Z+[A-Z0-9]`, which represents + # UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. + # + # For example, if a quota check failed with an error indicating the calling + # project hasn't enabled the accessed service, this can contain a URL pointing + # directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user + # which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at + # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + # Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota + # type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type + # or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, + }, + ], + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. + # This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. + }, + ], + }, + "timestamp": "A String", # Output only. [Output Only] Timestamp is shown only if there is an error. The field + # has // RFC3339 // + # text format. + }, + }, + ], "autoscaler": "A String", # Output only. [Output Only] The URL of theAutoscaler # that targets this instance group manager. "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. [Output Only] The status of bulk instance operation. @@ -7667,6 +8111,11 @@

Method Details

# on resize events (depending on the value set inupdatePolicy.instanceRedistributionType). "zones": [ # Zones where the regional managed instance group will create and manage # its instances. + # By default, a regional MIG doesn't automatically select an AI zone to create + # instances, even if an AI zone is available in the specified region. To + # create instances in an AI zone in the selected region, you must explicitly + # specify it in the distribution policy together with the other preferred + # zones. { "zone": "A String", # The URL of thezone. # The zone must exist in the region where the managed instance group is @@ -8336,6 +8785,117 @@

Method Details

"effective": True or False, # Output only. [Output Only] A bit indicating whether this configuration has # been applied to all managed instances in the group. }, + "appliedAcceleratorTopologies": [ # Output only. [Output Only] The accelerator topology applied to this MIG. + # Currently only one accelerator topology is supported. + { + "acceleratorTopology": "A String", # Output only. [Output Only] Topology in the format of: "16x16", "4x4x4", etc. + # The value is the same as configured in the WorkloadPolicy. + "state": "A String", # Output only. [Output Only] The state of the accelerator topology. + "stateDetails": { # Output only. [Output Only] The result of the latest accelerator topology state + # check. + "error": { # Output only. [Output Only] Encountered errors. + "errors": [ # [Output Only] The array of errors encountered while processing this + # operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error + # details. There is a set of defined message types to use for providing + # details.The syntax depends on the error code. For example, + # QuotaExceededInfo will have details when the error code is + # QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. + # + # Example of an error when contacting the "pubsub.googleapis.com" API when it + # is not enabled: + # + # { "reason": "API_DISABLED" + # "domain": "googleapis.com" + # "metadata": { + # "resource": "projects/123", + # "service": "pubsub.googleapis.com" + # } + # } + # + # This response indicates that the pubsub.googleapis.com API is not enabled. + # + # Example of an error that is returned when attempting to create a Spanner + # instance in a region that is out of stock: + # + # { "reason": "STOCKOUT" + # "domain": "spanner.googleapis.com", + # "metadata": { + # "availableRegions": "us-central1,us-east2" + # } + # } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain + # is typically the registered service name of the tool or product that + # generates the error. Example: "pubsub.googleapis.com". If the error is + # generated by some common infrastructure, the error domain must be a + # globally unique value that identifies the infrastructure. For Google API + # infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. + # + # Keys must match a regular expression of `a-z+` but should + # ideally be lowerCamelCase. Also, they must be limited to 64 characters in + # length. When identifying the current value of an exceeded limit, the units + # should be contained in the key, not the value. For example, rather than + # `{"instanceLimit": "100/request"}`, should be returned as, + # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of + # instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the + # proximate cause of the error. Error reasons are unique within a particular + # domain of errors. This should be at most 63 characters and match a + # regular expression of `A-Z+[A-Z0-9]`, which represents + # UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. + # + # For example, if a quota check failed with an error indicating the calling + # project hasn't enabled the accessed service, this can contain a URL pointing + # directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user + # which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at + # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + # Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota + # type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type + # or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, + }, + ], + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. + # This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. + }, + ], + }, + "timestamp": "A String", # Output only. [Output Only] Timestamp is shown only if there is an error. The field + # has // RFC3339 // + # text format. + }, + }, + ], "autoscaler": "A String", # Output only. [Output Only] The URL of theAutoscaler # that targets this instance group manager. "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. [Output Only] The status of bulk instance operation. @@ -8857,6 +9417,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -9216,6 +9788,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -9519,6 +10103,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -9814,6 +10410,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -10140,6 +10748,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -10446,6 +11066,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -10748,6 +11380,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -11038,6 +11682,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -11333,6 +11989,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -11639,6 +12307,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -11956,6 +12636,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -12273,6 +12965,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -12556,6 +13260,11 @@

Method Details

# on resize events (depending on the value set inupdatePolicy.instanceRedistributionType). "zones": [ # Zones where the regional managed instance group will create and manage # its instances. + # By default, a regional MIG doesn't automatically select an AI zone to create + # instances, even if an AI zone is available in the specified region. To + # create instances in an AI zone in the selected region, you must explicitly + # specify it in the distribution policy together with the other preferred + # zones. { "zone": "A String", # The URL of thezone. # The zone must exist in the region where the managed instance group is @@ -13225,6 +13934,117 @@

Method Details

"effective": True or False, # Output only. [Output Only] A bit indicating whether this configuration has # been applied to all managed instances in the group. }, + "appliedAcceleratorTopologies": [ # Output only. [Output Only] The accelerator topology applied to this MIG. + # Currently only one accelerator topology is supported. + { + "acceleratorTopology": "A String", # Output only. [Output Only] Topology in the format of: "16x16", "4x4x4", etc. + # The value is the same as configured in the WorkloadPolicy. + "state": "A String", # Output only. [Output Only] The state of the accelerator topology. + "stateDetails": { # Output only. [Output Only] The result of the latest accelerator topology state + # check. + "error": { # Output only. [Output Only] Encountered errors. + "errors": [ # [Output Only] The array of errors encountered while processing this + # operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error + # details. There is a set of defined message types to use for providing + # details.The syntax depends on the error code. For example, + # QuotaExceededInfo will have details when the error code is + # QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. + # + # Example of an error when contacting the "pubsub.googleapis.com" API when it + # is not enabled: + # + # { "reason": "API_DISABLED" + # "domain": "googleapis.com" + # "metadata": { + # "resource": "projects/123", + # "service": "pubsub.googleapis.com" + # } + # } + # + # This response indicates that the pubsub.googleapis.com API is not enabled. + # + # Example of an error that is returned when attempting to create a Spanner + # instance in a region that is out of stock: + # + # { "reason": "STOCKOUT" + # "domain": "spanner.googleapis.com", + # "metadata": { + # "availableRegions": "us-central1,us-east2" + # } + # } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain + # is typically the registered service name of the tool or product that + # generates the error. Example: "pubsub.googleapis.com". If the error is + # generated by some common infrastructure, the error domain must be a + # globally unique value that identifies the infrastructure. For Google API + # infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. + # + # Keys must match a regular expression of `a-z+` but should + # ideally be lowerCamelCase. Also, they must be limited to 64 characters in + # length. When identifying the current value of an exceeded limit, the units + # should be contained in the key, not the value. For example, rather than + # `{"instanceLimit": "100/request"}`, should be returned as, + # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of + # instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the + # proximate cause of the error. Error reasons are unique within a particular + # domain of errors. This should be at most 63 characters and match a + # regular expression of `A-Z+[A-Z0-9]`, which represents + # UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. + # + # For example, if a quota check failed with an error indicating the calling + # project hasn't enabled the accessed service, this can contain a URL pointing + # directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user + # which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at + # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + # Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota + # type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type + # or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, + }, + ], + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. + # This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. + }, + ], + }, + "timestamp": "A String", # Output only. [Output Only] Timestamp is shown only if there is an error. The field + # has // RFC3339 // + # text format. + }, + }, + ], "autoscaler": "A String", # Output only. [Output Only] The URL of theAutoscaler # that targets this instance group manager. "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. [Output Only] The status of bulk instance operation. @@ -13746,6 +14566,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -14105,6 +14937,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.regionInstanceGroups.html b/docs/dyn/compute_beta.regionInstanceGroups.html index 2985920147..b2100755ed 100644 --- a/docs/dyn/compute_beta.regionInstanceGroups.html +++ b/docs/dyn/compute_beta.regionInstanceGroups.html @@ -752,6 +752,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.regionInstanceTemplates.html b/docs/dyn/compute_beta.regionInstanceTemplates.html index c89284dcb2..71cf6cbcce 100644 --- a/docs/dyn/compute_beta.regionInstanceTemplates.html +++ b/docs/dyn/compute_beta.regionInstanceTemplates.html @@ -261,6 +261,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2661,6 +2673,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.regionInstances.html b/docs/dyn/compute_beta.regionInstances.html index 91452d1945..76111b8269 100644 --- a/docs/dyn/compute_beta.regionInstances.html +++ b/docs/dyn/compute_beta.regionInstances.html @@ -1804,6 +1804,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.regionInstantSnapshotGroups.html b/docs/dyn/compute_beta.regionInstantSnapshotGroups.html index 04dfbeb413..758f6ac03c 100644 --- a/docs/dyn/compute_beta.regionInstantSnapshotGroups.html +++ b/docs/dyn/compute_beta.regionInstantSnapshotGroups.html @@ -269,6 +269,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1016,6 +1028,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.regionInstantSnapshots.html b/docs/dyn/compute_beta.regionInstantSnapshots.html index ed7d4da805..86852be402 100644 --- a/docs/dyn/compute_beta.regionInstantSnapshots.html +++ b/docs/dyn/compute_beta.regionInstantSnapshots.html @@ -279,6 +279,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1138,6 +1150,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2557,6 +2581,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.regionMultiMigs.html b/docs/dyn/compute_beta.regionMultiMigs.html index 2ccaf92cf1..e8785f1970 100644 --- a/docs/dyn/compute_beta.regionMultiMigs.html +++ b/docs/dyn/compute_beta.regionMultiMigs.html @@ -260,6 +260,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -852,6 +864,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.regionNetworkEndpointGroups.html b/docs/dyn/compute_beta.regionNetworkEndpointGroups.html index d6fc246bda..a3e1308e41 100644 --- a/docs/dyn/compute_beta.regionNetworkEndpointGroups.html +++ b/docs/dyn/compute_beta.regionNetworkEndpointGroups.html @@ -314,6 +314,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -603,6 +615,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -932,6 +956,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1684,6 +1720,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.regionNetworkFirewallPolicies.html b/docs/dyn/compute_beta.regionNetworkFirewallPolicies.html index 3a4c8ac7c0..e4fd693c77 100644 --- a/docs/dyn/compute_beta.regionNetworkFirewallPolicies.html +++ b/docs/dyn/compute_beta.regionNetworkFirewallPolicies.html @@ -321,6 +321,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -795,6 +807,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1077,6 +1101,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1363,6 +1399,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3764,6 +3812,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5116,6 +5176,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5415,6 +5487,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5886,6 +5970,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6168,6 +6264,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6450,6 +6558,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.regionNetworkPolicies.html b/docs/dyn/compute_beta.regionNetworkPolicies.html index 5f650eec0b..39db4dd4f1 100644 --- a/docs/dyn/compute_beta.regionNetworkPolicies.html +++ b/docs/dyn/compute_beta.regionNetworkPolicies.html @@ -293,6 +293,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -655,6 +667,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1240,6 +1264,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1868,6 +1904,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2511,6 +2559,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2875,6 +2935,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3157,6 +3229,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3439,6 +3523,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.regionNotificationEndpoints.html b/docs/dyn/compute_beta.regionNotificationEndpoints.html index 48f71631e0..d5229c30de 100644 --- a/docs/dyn/compute_beta.regionNotificationEndpoints.html +++ b/docs/dyn/compute_beta.regionNotificationEndpoints.html @@ -74,6 +74,12 @@

Compute Engine API . regionNotificationEndpoints

Instance Methods

+

+ aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)

+

Retrieves the list of all NotificationEndpoint resources,

+

+ aggregatedList_next()

+

Retrieves the next page of results.

close()

Close httplib2 connections.

@@ -96,6 +102,257 @@

Instance Methods

testIamPermissions(project, region, resource, body=None, x__xgafv=None)

Returns permissions that a caller has on the specified resource.

Method Details

+
+ aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None) +
Retrieves the list of all NotificationEndpoint resources,
+regional and global, available to the specified project.
+
+Args:
+  project: string, Name of the project scoping this request. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most
+Compute resources support two types of filter expressions:
+expressions that support regular expressions and expressions that follow
+API improvement proposal AIP-160.
+These two types of filter expressions cannot be mixed in one request.
+
+If you want to use AIP-160, your expression must specify the field name, an
+operator, and the value that you want to use for filtering. The value
+must be a string, a number, or a boolean. The operator
+must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
+
+For example, if you are filtering Compute Engine instances, you can
+exclude instances named `example-instance` by specifying
+`name != example-instance`.
+
+The `:*` comparison can be used to test whether a key has been defined.
+For example, to find all objects with `owner` label use:
+```
+labels.owner:*
+```
+
+You can also filter nested fields. For example, you could specify
+`scheduling.automaticRestart = false` to include instances only
+if they are not scheduled for automatic restarts. You can use filtering
+on nested fields to filter based onresource labels.
+
+To filter on multiple expressions, provide each separate expression within
+parentheses. For example:
+```
+(scheduling.automaticRestart = true)
+(cpuPlatform = "Intel Skylake")
+```
+By default, each expression is an `AND` expression. However, you
+can include `AND` and `OR` expressions explicitly.
+For example:
+```
+(cpuPlatform = "Intel Skylake") OR
+(cpuPlatform = "Intel Broadwell") AND
+(scheduling.automaticRestart = true)
+```
+
+If you want to use a regular expression, use the `eq` (equal) or `ne`
+(not equal) operator against a single un-parenthesized expression with or
+without quotes or against multiple parenthesized expressions. Examples:
+
+`fieldname eq unquoted literal`
+`fieldname eq 'single quoted literal'`
+`fieldname eq "double quoted literal"`
+`(fieldname1 eq literal) (fieldname2 ne "literal")`
+
+The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
+The literal value must match the entire field.
+
+For example, to filter for instances that do not end with name "instance",
+you would use `name ne .*instance`.
+
+You cannot combine constraints on multiple fields using regular
+expressions.
+  includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
+global) should be included in the response. For new resource types added
+after this field, the flag has no effect as new resource types will always
+include every visible scope for each scope type in response. For resource
+types which predate this field, if this flag is omitted or false, only
+scopes of the scope types where the resource type is expected to be found
+will be included.
+  maxResults: integer, The maximum number of results per page that should be returned.
+If the number of available results is larger than `maxResults`,
+Compute Engine returns a `nextPageToken` that can be used to get
+the next page of results in subsequent list requests. Acceptable values are
+`0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results
+are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation
+timestamp using `orderBy="creationTimestamp desc"`. This sorts
+results based on the `creationTimestamp` field in
+reverse chronological order (newest result first). Use this to sort
+resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by `name` or
+`creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the
+`nextPageToken` returned by a previous list request to get
+the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
+of failure. The default value is false.
+
+For example, when partial success behavior is enabled, aggregatedList for a
+single zone scope either returns all resources in the zone or no resources,
+with an error code.
+  serviceProjectNumber: string, The Shared VPC service project id or service project number for which
+aggregated list request is invoked for subnetworks list-usable api.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Contains a list of NotificationEndpointsScopedList.
+  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+  "items": { # A list of NotificationEndpointsScopedList resources.
+    "a_key": { # Name of the scope containing this set of NotificationEndpoints.
+      "resources": [ # A list of NotificationEndpoints contained in this scope.
+        { # Represents a notification endpoint.
+            #
+            # A notification endpoint resource defines an endpoint to receive notifications
+            # when there are status changes detected by the associated health check
+            # service.
+            #
+            # For more information, see
+            # Health checks overview.
+          "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+              # text format.
+          "description": "A String", # An optional description of this resource. Provide this property when you
+              # create the resource.
+          "grpcSettings": { # Represents a gRPC setting that describes one gRPC notification endpoint and # Settings of the gRPC notification endpoint including the endpoint URL and
+              # the retry duration.
+              # the retry duration attempting to send notification to this endpoint.
+            "authority": "A String", # Optional. If specified, this field is used to set the authority header by
+                # the sender of notifications. See
+                # https://tools.ietf.org/html/rfc7540#section-8.1.2.3
+            "endpoint": "A String", # Endpoint to which gRPC notifications are sent. This must be a valid
+                # gRPCLB DNS name.
+            "payloadName": "A String", # Optional. If specified, this field is used to populate the "name" field
+                # in gRPC requests.
+            "resendInterval": { # A Duration represents a fixed-length span of time represented # Optional. This field is used to configure how often to send a full update
+                # of all non-healthy backends. If unspecified, full updates are not sent.
+                # If specified, must be in the range between 600 seconds to 3600 seconds.
+                # Nanos are disallowed. Can only be set for regional notification
+                # endpoints.
+                # as a count of seconds and fractions of seconds at nanosecond
+                # resolution. It is independent of any calendar and concepts like "day"
+                # or "month". Range is approximately 10,000 years.
+              "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+                  # Durations less than one second are represented with a 0
+                  # `seconds` field and a positive `nanos` field. Must be from 0
+                  # to 999,999,999 inclusive.
+              "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+                  # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+                  # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+            },
+            "retryDurationSec": 42, # How much time (in seconds) is spent attempting notification retries
+                # until a successful response is received. Default is 30s. Limit is 20m
+                # (1200s). Must be a positive number.
+          },
+          "id": "A String", # Output only. [Output Only] A unique identifier for this resource type. The server
+              # generates this identifier.
+          "kind": "compute#notificationEndpoint", # Output only. [Output Only] Type of the resource. Alwayscompute#notificationEndpoint for notification endpoints.
+          "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+              # The name must be 1-63 characters long, and comply withRFC1035.
+              # Specifically, the name must be 1-63 characters long and match the regular
+              # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
+              # character must be a lowercase letter, and all following characters must
+              # be a dash, lowercase letter, or digit, except the last character, which
+              # cannot be a dash.
+          "region": "A String", # Output only. [Output Only] URL of the region where the notification endpoint resides.
+              # This field applies only to the regional resource. You must specify this
+              # field as part of the HTTP request URL. It is not settable as a field in
+              # the request body.
+          "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
+        },
+      ],
+      "warning": { # Informational warning which replaces the list of
+          # notification endpoints when the list is empty.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+            # Engine returns NO_RESULTS_ON_PAGE if there
+            # are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key:
+            # value format. For example:
+            #
+            # "data": [
+            #   {
+            #    "key": "scope",
+            #    "value": "zones/us-east1-d"
+            #   }
+          {
+            "key": "A String", # [Output Only] A key that provides more detail on the warning being
+                # returned. For example, for warnings where there are no results in a list
+                # request for a particular zone, this key might be scope and
+                # the key value might be the zone name. Other examples might be a key
+                # indicating a deprecated resource and a suggested replacement, or a
+                # warning about invalid network settings (for example, if an instance
+                # attempts to perform IP forwarding but is not enabled for IP forwarding).
+            "value": "A String", # [Output Only] A warning data value corresponding to the key.
+          },
+        ],
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+      },
+    },
+  },
+  "kind": "compute#notificationEndpointAggregatedList", # Output only. Type of resource.
+  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for
+      # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
+      # the query parameter pageToken in the next list request.
+      # Subsequent list requests will have their own nextPageToken to
+      # continue paging through the results.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined URL for this resource.
+  "unreachables": [ # Output only. [Output Only] Unreachable resources.
+    "A String",
+  ],
+  "warning": { # [Output Only] Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+        # Engine returns NO_RESULTS_ON_PAGE if there
+        # are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key:
+        # value format. For example:
+        #
+        # "data": [
+        #   {
+        #    "key": "scope",
+        #    "value": "zones/us-east1-d"
+        #   }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being
+            # returned. For example, for warnings where there are no results in a list
+            # request for a particular zone, this key might be scope and
+            # the key value might be the zone name. Other examples might be a key
+            # indicating a deprecated resource and a suggested replacement, or a
+            # warning about invalid network settings (for example, if an instance
+            # attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ aggregatedList_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.
+        
+
+
close()
Close httplib2 connections.
@@ -263,6 +520,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -682,6 +951,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.regionOperations.html b/docs/dyn/compute_beta.regionOperations.html index 2554a48fbc..b774ac6711 100644 --- a/docs/dyn/compute_beta.regionOperations.html +++ b/docs/dyn/compute_beta.regionOperations.html @@ -264,6 +264,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -619,6 +631,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -953,6 +977,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.regionSecurityPolicies.html b/docs/dyn/compute_beta.regionSecurityPolicies.html index 2d2c639c73..9aa1e0c8a2 100644 --- a/docs/dyn/compute_beta.regionSecurityPolicies.html +++ b/docs/dyn/compute_beta.regionSecurityPolicies.html @@ -731,6 +731,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1017,6 +1029,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1247,20 +1271,20 @@

Method Details

"ddosProtectionConfig": { "ddosAdaptiveProtection": "A String", "ddosImpactedBaselineThreshold": 3.14, # DDoS Protection for Network Load Balancers (and VMs with public IPs) - # builds DDos mitigations that minimize collateral damage. It quantifies + # builds DDoS mitigations that minimize collateral damage. It quantifies # this as the fraction of a non-abuse baseline that's inadvertently # blocked. # # Rules whose collateral damage exceeds ddosImpactedBaselineThreshold will # not be deployed. Using a lower value will prioritize keeping collateral # damage low, possibly at the cost of its effectiveness in rate limiting - # some or all of the attack. It should typically be unset, so Advanced DDos + # some or all of the attack. It should typically be unset, so Advanced DDoS # (and Adaptive Protection) uses the best mitigation it can find. Setting # the threshold is advised if there are logs for false positive detections - # with high collateral damage, and will cause Advanced DDos to attempt to - # find a less aggressive rule that satisfies the constraint; Failing that, - # it will fall back to no mitigation (smaller attack) or to broader network - # throttles (larger attack). + # with high collateral damage, and will cause Advanced DDoS to attempt to + # find a less aggressive rule that satisfies the constraint. If a suitable + # rule cannot be found, the system falls back to either no mitigation for + # smaller attacks or broader network throttles for larger ones. "ddosProtection": "A String", }, "description": "A String", # An optional description of this resource. Provide this property when you @@ -2458,20 +2482,20 @@

Method Details

"ddosProtectionConfig": { "ddosAdaptiveProtection": "A String", "ddosImpactedBaselineThreshold": 3.14, # DDoS Protection for Network Load Balancers (and VMs with public IPs) - # builds DDos mitigations that minimize collateral damage. It quantifies + # builds DDoS mitigations that minimize collateral damage. It quantifies # this as the fraction of a non-abuse baseline that's inadvertently # blocked. # # Rules whose collateral damage exceeds ddosImpactedBaselineThreshold will # not be deployed. Using a lower value will prioritize keeping collateral # damage low, possibly at the cost of its effectiveness in rate limiting - # some or all of the attack. It should typically be unset, so Advanced DDos + # some or all of the attack. It should typically be unset, so Advanced DDoS # (and Adaptive Protection) uses the best mitigation it can find. Setting # the threshold is advised if there are logs for false positive detections - # with high collateral damage, and will cause Advanced DDos to attempt to - # find a less aggressive rule that satisfies the constraint; Failing that, - # it will fall back to no mitigation (smaller attack) or to broader network - # throttles (larger attack). + # with high collateral damage, and will cause Advanced DDoS to attempt to + # find a less aggressive rule that satisfies the constraint. If a suitable + # rule cannot be found, the system falls back to either no mitigation for + # smaller attacks or broader network throttles for larger ones. "ddosProtection": "A String", }, "description": "A String", # An optional description of this resource. Provide this property when you @@ -3232,6 +3256,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3548,20 +3584,20 @@

Method Details

"ddosProtectionConfig": { "ddosAdaptiveProtection": "A String", "ddosImpactedBaselineThreshold": 3.14, # DDoS Protection for Network Load Balancers (and VMs with public IPs) - # builds DDos mitigations that minimize collateral damage. It quantifies + # builds DDoS mitigations that minimize collateral damage. It quantifies # this as the fraction of a non-abuse baseline that's inadvertently # blocked. # # Rules whose collateral damage exceeds ddosImpactedBaselineThreshold will # not be deployed. Using a lower value will prioritize keeping collateral # damage low, possibly at the cost of its effectiveness in rate limiting - # some or all of the attack. It should typically be unset, so Advanced DDos + # some or all of the attack. It should typically be unset, so Advanced DDoS # (and Adaptive Protection) uses the best mitigation it can find. Setting # the threshold is advised if there are logs for false positive detections - # with high collateral damage, and will cause Advanced DDos to attempt to - # find a less aggressive rule that satisfies the constraint; Failing that, - # it will fall back to no mitigation (smaller attack) or to broader network - # throttles (larger attack). + # with high collateral damage, and will cause Advanced DDoS to attempt to + # find a less aggressive rule that satisfies the constraint. If a suitable + # rule cannot be found, the system falls back to either no mitigation for + # smaller attacks or broader network throttles for larger ones. "ddosProtection": "A String", }, "description": "A String", # An optional description of this resource. Provide this property when you @@ -4325,20 +4361,20 @@

Method Details

"ddosProtectionConfig": { "ddosAdaptiveProtection": "A String", "ddosImpactedBaselineThreshold": 3.14, # DDoS Protection for Network Load Balancers (and VMs with public IPs) - # builds DDos mitigations that minimize collateral damage. It quantifies + # builds DDoS mitigations that minimize collateral damage. It quantifies # this as the fraction of a non-abuse baseline that's inadvertently # blocked. # # Rules whose collateral damage exceeds ddosImpactedBaselineThreshold will # not be deployed. Using a lower value will prioritize keeping collateral # damage low, possibly at the cost of its effectiveness in rate limiting - # some or all of the attack. It should typically be unset, so Advanced DDos + # some or all of the attack. It should typically be unset, so Advanced DDoS # (and Adaptive Protection) uses the best mitigation it can find. Setting # the threshold is advised if there are logs for false positive detections - # with high collateral damage, and will cause Advanced DDos to attempt to - # find a less aggressive rule that satisfies the constraint; Failing that, - # it will fall back to no mitigation (smaller attack) or to broader network - # throttles (larger attack). + # with high collateral damage, and will cause Advanced DDoS to attempt to + # find a less aggressive rule that satisfies the constraint. If a suitable + # rule cannot be found, the system falls back to either no mitigation for + # smaller attacks or broader network throttles for larger ones. "ddosProtection": "A String", }, "description": "A String", # An optional description of this resource. Provide this property when you @@ -5099,6 +5135,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5841,6 +5889,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6110,6 +6170,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6408,6 +6480,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.regionSnapshotSettings.html b/docs/dyn/compute_beta.regionSnapshotSettings.html index 5a4d92c68b..5b05bcdaaa 100644 --- a/docs/dyn/compute_beta.regionSnapshotSettings.html +++ b/docs/dyn/compute_beta.regionSnapshotSettings.html @@ -320,6 +320,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.regionSnapshots.html b/docs/dyn/compute_beta.regionSnapshots.html index cca4a00d9a..b0dc96eddb 100644 --- a/docs/dyn/compute_beta.regionSnapshots.html +++ b/docs/dyn/compute_beta.regionSnapshots.html @@ -279,6 +279,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1591,6 +1603,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3236,6 +3260,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.regionSslCertificates.html b/docs/dyn/compute_beta.regionSslCertificates.html index 180a6979eb..e1f6049642 100644 --- a/docs/dyn/compute_beta.regionSslCertificates.html +++ b/docs/dyn/compute_beta.regionSslCertificates.html @@ -263,6 +263,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -736,6 +748,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.regionSslPolicies.html b/docs/dyn/compute_beta.regionSslPolicies.html index fa2fe436bb..4f6d8d0464 100644 --- a/docs/dyn/compute_beta.regionSslPolicies.html +++ b/docs/dyn/compute_beta.regionSslPolicies.html @@ -272,6 +272,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -448,8 +460,9 @@

Method Details

# lowercase letter, or digit, except the last character, which cannot be a # dash. "profile": "A String", # Profile specifies the set of SSL features that can be used by the load - # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features - # to enable must be specified in the customFeatures field. + # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED,FIPS_202205, or CUSTOM. If usingCUSTOM, the set of SSL features to enable must be specified in + # the customFeatures field. If using FIPS_202205, + # the min_tls_version field must be set to TLS_1_2. "region": "A String", # Output only. [Output Only] URL of the region where the regional SSL policy # resides. This field is not applicable to global SSL policies. "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. @@ -535,8 +548,9 @@

Method Details

# lowercase letter, or digit, except the last character, which cannot be a # dash. "profile": "A String", # Profile specifies the set of SSL features that can be used by the load - # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features - # to enable must be specified in the customFeatures field. + # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED,FIPS_202205, or CUSTOM. If usingCUSTOM, the set of SSL features to enable must be specified in + # the customFeatures field. If using FIPS_202205, + # the min_tls_version field must be set to TLS_1_2. "region": "A String", # Output only. [Output Only] URL of the region where the regional SSL policy # resides. This field is not applicable to global SSL policies. "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. @@ -724,6 +738,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -985,8 +1011,9 @@

Method Details

# lowercase letter, or digit, except the last character, which cannot be a # dash. "profile": "A String", # Profile specifies the set of SSL features that can be used by the load - # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features - # to enable must be specified in the customFeatures field. + # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED,FIPS_202205, or CUSTOM. If usingCUSTOM, the set of SSL features to enable must be specified in + # the customFeatures field. If using FIPS_202205, + # the min_tls_version field must be set to TLS_1_2. "region": "A String", # Output only. [Output Only] URL of the region where the regional SSL policy # resides. This field is not applicable to global SSL policies. "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. @@ -1227,8 +1254,9 @@

Method Details

# lowercase letter, or digit, except the last character, which cannot be a # dash. "profile": "A String", # Profile specifies the set of SSL features that can be used by the load - # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features - # to enable must be specified in the customFeatures field. + # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED,FIPS_202205, or CUSTOM. If usingCUSTOM, the set of SSL features to enable must be specified in + # the customFeatures field. If using FIPS_202205, + # the min_tls_version field must be set to TLS_1_2. "region": "A String", # Output only. [Output Only] URL of the region where the regional SSL policy # resides. This field is not applicable to global SSL policies. "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. @@ -1416,6 +1444,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.regionTargetHttpProxies.html b/docs/dyn/compute_beta.regionTargetHttpProxies.html index 2ef5c2e091..202cf0e797 100644 --- a/docs/dyn/compute_beta.regionTargetHttpProxies.html +++ b/docs/dyn/compute_beta.regionTargetHttpProxies.html @@ -266,6 +266,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -729,6 +741,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1250,6 +1274,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.regionTargetHttpsProxies.html b/docs/dyn/compute_beta.regionTargetHttpsProxies.html index b7aff0f21e..f94a7233f2 100644 --- a/docs/dyn/compute_beta.regionTargetHttpsProxies.html +++ b/docs/dyn/compute_beta.regionTargetHttpsProxies.html @@ -272,6 +272,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -931,6 +943,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1728,6 +1752,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2020,6 +2056,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2308,6 +2356,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.regionTargetTcpProxies.html b/docs/dyn/compute_beta.regionTargetTcpProxies.html index 736fdf976e..c8e7c719ec 100644 --- a/docs/dyn/compute_beta.regionTargetTcpProxies.html +++ b/docs/dyn/compute_beta.regionTargetTcpProxies.html @@ -263,6 +263,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -646,6 +658,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.regionUrlMaps.html b/docs/dyn/compute_beta.regionUrlMaps.html index 0d9d176f89..1b7115c9fe 100644 --- a/docs/dyn/compute_beta.regionUrlMaps.html +++ b/docs/dyn/compute_beta.regionUrlMaps.html @@ -264,6 +264,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -7662,6 +7674,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -7959,6 +7983,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -15494,6 +15530,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -19356,6 +19404,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.reservationBlocks.html b/docs/dyn/compute_beta.reservationBlocks.html index e057b7230a..c4c0882fd6 100644 --- a/docs/dyn/compute_beta.reservationBlocks.html +++ b/docs/dyn/compute_beta.reservationBlocks.html @@ -977,6 +977,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.reservationSlots.html b/docs/dyn/compute_beta.reservationSlots.html index 45016e3404..693264d09a 100644 --- a/docs/dyn/compute_beta.reservationSlots.html +++ b/docs/dyn/compute_beta.reservationSlots.html @@ -80,6 +80,9 @@

Instance Methods

get(project, zone, parentName, reservationSlot, x__xgafv=None)

Retrieves information about the specified reservation slot.

+

+ getVersion(project, zone, parentName, reservationSlot, body=None, requestId=None, x__xgafv=None)

+

Allows customers to get SBOM versions of a reservation slot.

list(project, zone, parentName, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Retrieves a list of reservation slots under a single reservation.

@@ -167,6 +170,311 @@

Method Details

}
+
+ getVersion(project, zone, parentName, reservationSlot, body=None, requestId=None, x__xgafv=None) +
Allows customers to get SBOM versions of a reservation slot.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, Name of the zone for this request. Zone name should conform to RFC1035. (required)
+  parentName: string, The name of the parent reservation and parent block. In the format of
+reservations/{reservation_name}/reservationBlocks/{reservation_block_name}/reservationSubBlocks/{reservation_sub_block_name} (required)
+  reservationSlot: string, The name of the reservation slot.
+Name should conform to RFC1035 or be a resource ID. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "sbomSelections": [ # The SBOM selection to return. Duplicate values in the list will be ignored.
+    "A String",
+  ],
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/beta/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+          # name and the value is the version.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+          # component name and the value is the version.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+
list(project, zone, parentName, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Retrieves a list of reservation slots under a single reservation.
@@ -574,6 +882,18 @@ 

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.reservationSubBlocks.html b/docs/dyn/compute_beta.reservationSubBlocks.html index a17b30f9d2..43666fb518 100644 --- a/docs/dyn/compute_beta.reservationSubBlocks.html +++ b/docs/dyn/compute_beta.reservationSubBlocks.html @@ -83,6 +83,9 @@

Instance Methods

getIamPolicy(project, zone, parentResource, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)

Gets the access control policy for a resource. May be empty if no such

+

+ getVersion(project, zone, parentName, reservationSubBlock, body=None, requestId=None, x__xgafv=None)

+

Allows customers to get SBOM versions of a reservation subBlock.

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.

@@ -583,6 +586,311 @@

Method Details

}
+
+ getVersion(project, zone, parentName, reservationSubBlock, body=None, requestId=None, x__xgafv=None) +
Allows customers to get SBOM versions of a reservation subBlock.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, Name of the zone for this request. Zone name should conform to RFC1035. (required)
+  parentName: string, The name of the parent reservation and parent block. In the format of
+reservations/{reservation_name}/reservationBlocks/{reservation_block_name} (required)
+  reservationSubBlock: string, The name of the reservation subBlock.
+Name should conform to RFC1035 or be a resource ID. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "sbomSelections": [ # The SBOM selection to return.
+    "A String",
+  ],
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/beta/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+          # name and the value is the version.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+          # component name and the value is the version.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+
list(project, zone, parentName, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Retrieves a list of reservation subBlocks under a single reservation.
@@ -980,6 +1288,18 @@ 

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1278,6 +1598,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.reservations.html b/docs/dyn/compute_beta.reservations.html index eeb9290a1d..66b89e9811 100644 --- a/docs/dyn/compute_beta.reservations.html +++ b/docs/dyn/compute_beta.reservations.html @@ -719,6 +719,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1871,6 +1883,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2554,6 +2578,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2845,6 +2881,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -4281,6 +4329,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.resourcePolicies.html b/docs/dyn/compute_beta.resourcePolicies.html index 6b2288a63b..61c76754fa 100644 --- a/docs/dyn/compute_beta.resourcePolicies.html +++ b/docs/dyn/compute_beta.resourcePolicies.html @@ -609,6 +609,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1550,6 +1562,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2260,6 +2284,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.rolloutPlans.html b/docs/dyn/compute_beta.rolloutPlans.html index 6a091bb2d8..66429116c8 100644 --- a/docs/dyn/compute_beta.rolloutPlans.html +++ b/docs/dyn/compute_beta.rolloutPlans.html @@ -259,6 +259,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -749,6 +761,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.rollouts.html b/docs/dyn/compute_beta.rollouts.html index 950e377786..e6ea98d309 100644 --- a/docs/dyn/compute_beta.rollouts.html +++ b/docs/dyn/compute_beta.rollouts.html @@ -258,6 +258,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -543,6 +555,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.routers.html b/docs/dyn/compute_beta.routers.html index b08c8c9b98..334d0a9013 100644 --- a/docs/dyn/compute_beta.routers.html +++ b/docs/dyn/compute_beta.routers.html @@ -1037,6 +1037,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1319,6 +1331,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1601,6 +1625,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -4097,6 +4133,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6244,6 +6292,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6588,6 +6648,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6982,6 +7054,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -8859,6 +8943,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -9203,6 +9299,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -9597,6 +9705,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.routes.html b/docs/dyn/compute_beta.routes.html index 40fabf0f46..443dcbd609 100644 --- a/docs/dyn/compute_beta.routes.html +++ b/docs/dyn/compute_beta.routes.html @@ -262,6 +262,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -891,6 +903,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.securityPolicies.html b/docs/dyn/compute_beta.securityPolicies.html index 6bd00ac952..9e20b42601 100644 --- a/docs/dyn/compute_beta.securityPolicies.html +++ b/docs/dyn/compute_beta.securityPolicies.html @@ -742,6 +742,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1072,20 +1084,20 @@

Method Details

"ddosProtectionConfig": { "ddosAdaptiveProtection": "A String", "ddosImpactedBaselineThreshold": 3.14, # DDoS Protection for Network Load Balancers (and VMs with public IPs) - # builds DDos mitigations that minimize collateral damage. It quantifies + # builds DDoS mitigations that minimize collateral damage. It quantifies # this as the fraction of a non-abuse baseline that's inadvertently # blocked. # # Rules whose collateral damage exceeds ddosImpactedBaselineThreshold will # not be deployed. Using a lower value will prioritize keeping collateral # damage low, possibly at the cost of its effectiveness in rate limiting - # some or all of the attack. It should typically be unset, so Advanced DDos + # some or all of the attack. It should typically be unset, so Advanced DDoS # (and Adaptive Protection) uses the best mitigation it can find. Setting # the threshold is advised if there are logs for false positive detections - # with high collateral damage, and will cause Advanced DDos to attempt to - # find a less aggressive rule that satisfies the constraint; Failing that, - # it will fall back to no mitigation (smaller attack) or to broader network - # throttles (larger attack). + # with high collateral damage, and will cause Advanced DDoS to attempt to + # find a less aggressive rule that satisfies the constraint. If a suitable + # rule cannot be found, the system falls back to either no mitigation for + # smaller attacks or broader network throttles for larger ones. "ddosProtection": "A String", }, "description": "A String", # An optional description of this resource. Provide this property when you @@ -1938,6 +1950,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2167,20 +2191,20 @@

Method Details

"ddosProtectionConfig": { "ddosAdaptiveProtection": "A String", "ddosImpactedBaselineThreshold": 3.14, # DDoS Protection for Network Load Balancers (and VMs with public IPs) - # builds DDos mitigations that minimize collateral damage. It quantifies + # builds DDoS mitigations that minimize collateral damage. It quantifies # this as the fraction of a non-abuse baseline that's inadvertently # blocked. # # Rules whose collateral damage exceeds ddosImpactedBaselineThreshold will # not be deployed. Using a lower value will prioritize keeping collateral # damage low, possibly at the cost of its effectiveness in rate limiting - # some or all of the attack. It should typically be unset, so Advanced DDos + # some or all of the attack. It should typically be unset, so Advanced DDoS # (and Adaptive Protection) uses the best mitigation it can find. Setting # the threshold is advised if there are logs for false positive detections - # with high collateral damage, and will cause Advanced DDos to attempt to - # find a less aggressive rule that satisfies the constraint; Failing that, - # it will fall back to no mitigation (smaller attack) or to broader network - # throttles (larger attack). + # with high collateral damage, and will cause Advanced DDoS to attempt to + # find a less aggressive rule that satisfies the constraint. If a suitable + # rule cannot be found, the system falls back to either no mitigation for + # smaller attacks or broader network throttles for larger ones. "ddosProtection": "A String", }, "description": "A String", # An optional description of this resource. Provide this property when you @@ -3376,20 +3400,20 @@

Method Details

"ddosProtectionConfig": { "ddosAdaptiveProtection": "A String", "ddosImpactedBaselineThreshold": 3.14, # DDoS Protection for Network Load Balancers (and VMs with public IPs) - # builds DDos mitigations that minimize collateral damage. It quantifies + # builds DDoS mitigations that minimize collateral damage. It quantifies # this as the fraction of a non-abuse baseline that's inadvertently # blocked. # # Rules whose collateral damage exceeds ddosImpactedBaselineThreshold will # not be deployed. Using a lower value will prioritize keeping collateral # damage low, possibly at the cost of its effectiveness in rate limiting - # some or all of the attack. It should typically be unset, so Advanced DDos + # some or all of the attack. It should typically be unset, so Advanced DDoS # (and Adaptive Protection) uses the best mitigation it can find. Setting # the threshold is advised if there are logs for false positive detections - # with high collateral damage, and will cause Advanced DDos to attempt to - # find a less aggressive rule that satisfies the constraint; Failing that, - # it will fall back to no mitigation (smaller attack) or to broader network - # throttles (larger attack). + # with high collateral damage, and will cause Advanced DDoS to attempt to + # find a less aggressive rule that satisfies the constraint. If a suitable + # rule cannot be found, the system falls back to either no mitigation for + # smaller attacks or broader network throttles for larger ones. "ddosProtection": "A String", }, "description": "A String", # An optional description of this resource. Provide this property when you @@ -4150,6 +4174,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -4464,20 +4500,20 @@

Method Details

"ddosProtectionConfig": { "ddosAdaptiveProtection": "A String", "ddosImpactedBaselineThreshold": 3.14, # DDoS Protection for Network Load Balancers (and VMs with public IPs) - # builds DDos mitigations that minimize collateral damage. It quantifies + # builds DDoS mitigations that minimize collateral damage. It quantifies # this as the fraction of a non-abuse baseline that's inadvertently # blocked. # # Rules whose collateral damage exceeds ddosImpactedBaselineThreshold will # not be deployed. Using a lower value will prioritize keeping collateral # damage low, possibly at the cost of its effectiveness in rate limiting - # some or all of the attack. It should typically be unset, so Advanced DDos + # some or all of the attack. It should typically be unset, so Advanced DDoS # (and Adaptive Protection) uses the best mitigation it can find. Setting # the threshold is advised if there are logs for false positive detections - # with high collateral damage, and will cause Advanced DDos to attempt to - # find a less aggressive rule that satisfies the constraint; Failing that, - # it will fall back to no mitigation (smaller attack) or to broader network - # throttles (larger attack). + # with high collateral damage, and will cause Advanced DDoS to attempt to + # find a less aggressive rule that satisfies the constraint. If a suitable + # rule cannot be found, the system falls back to either no mitigation for + # smaller attacks or broader network throttles for larger ones. "ddosProtection": "A String", }, "description": "A String", # An optional description of this resource. Provide this property when you @@ -5375,20 +5411,20 @@

Method Details

"ddosProtectionConfig": { "ddosAdaptiveProtection": "A String", "ddosImpactedBaselineThreshold": 3.14, # DDoS Protection for Network Load Balancers (and VMs with public IPs) - # builds DDos mitigations that minimize collateral damage. It quantifies + # builds DDoS mitigations that minimize collateral damage. It quantifies # this as the fraction of a non-abuse baseline that's inadvertently # blocked. # # Rules whose collateral damage exceeds ddosImpactedBaselineThreshold will # not be deployed. Using a lower value will prioritize keeping collateral # damage low, possibly at the cost of its effectiveness in rate limiting - # some or all of the attack. It should typically be unset, so Advanced DDos + # some or all of the attack. It should typically be unset, so Advanced DDoS # (and Adaptive Protection) uses the best mitigation it can find. Setting # the threshold is advised if there are logs for false positive detections - # with high collateral damage, and will cause Advanced DDos to attempt to - # find a less aggressive rule that satisfies the constraint; Failing that, - # it will fall back to no mitigation (smaller attack) or to broader network - # throttles (larger attack). + # with high collateral damage, and will cause Advanced DDoS to attempt to + # find a less aggressive rule that satisfies the constraint. If a suitable + # rule cannot be found, the system falls back to either no mitigation for + # smaller attacks or broader network throttles for larger ones. "ddosProtection": "A String", }, "description": "A String", # An optional description of this resource. Provide this property when you @@ -6149,6 +6185,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6890,6 +6938,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -7158,6 +7218,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -7445,6 +7517,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.serviceAttachments.html b/docs/dyn/compute_beta.serviceAttachments.html index f513fdba06..59a065f657 100644 --- a/docs/dyn/compute_beta.serviceAttachments.html +++ b/docs/dyn/compute_beta.serviceAttachments.html @@ -618,6 +618,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1579,6 +1591,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2307,6 +2331,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.snapshotGroups.html b/docs/dyn/compute_beta.snapshotGroups.html index df5f2353c8..60eaf2acef 100644 --- a/docs/dyn/compute_beta.snapshotGroups.html +++ b/docs/dyn/compute_beta.snapshotGroups.html @@ -268,6 +268,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1001,6 +1013,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.snapshotSettings.html b/docs/dyn/compute_beta.snapshotSettings.html index eb3e67f2af..5a4802116e 100644 --- a/docs/dyn/compute_beta.snapshotSettings.html +++ b/docs/dyn/compute_beta.snapshotSettings.html @@ -318,6 +318,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.snapshots.html b/docs/dyn/compute_beta.snapshots.html index 91c28aace4..cea959a5f7 100644 --- a/docs/dyn/compute_beta.snapshots.html +++ b/docs/dyn/compute_beta.snapshots.html @@ -802,6 +802,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2114,6 +2126,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3745,6 +3769,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.sslCertificates.html b/docs/dyn/compute_beta.sslCertificates.html index 8ddd7105e0..40b86d94b1 100644 --- a/docs/dyn/compute_beta.sslCertificates.html +++ b/docs/dyn/compute_beta.sslCertificates.html @@ -549,6 +549,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1018,6 +1030,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.sslPolicies.html b/docs/dyn/compute_beta.sslPolicies.html index 80b015fb0b..be8fa19770 100644 --- a/docs/dyn/compute_beta.sslPolicies.html +++ b/docs/dyn/compute_beta.sslPolicies.html @@ -264,8 +264,9 @@

Method Details

# lowercase letter, or digit, except the last character, which cannot be a # dash. "profile": "A String", # Profile specifies the set of SSL features that can be used by the load - # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features - # to enable must be specified in the customFeatures field. + # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED,FIPS_202205, or CUSTOM. If usingCUSTOM, the set of SSL features to enable must be specified in + # the customFeatures field. If using FIPS_202205, + # the min_tls_version field must be set to TLS_1_2. "region": "A String", # Output only. [Output Only] URL of the region where the regional SSL policy # resides. This field is not applicable to global SSL policies. "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. @@ -548,6 +549,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -723,8 +736,9 @@

Method Details

# lowercase letter, or digit, except the last character, which cannot be a # dash. "profile": "A String", # Profile specifies the set of SSL features that can be used by the load - # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features - # to enable must be specified in the customFeatures field. + # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED,FIPS_202205, or CUSTOM. If usingCUSTOM, the set of SSL features to enable must be specified in + # the customFeatures field. If using FIPS_202205, + # the min_tls_version field must be set to TLS_1_2. "region": "A String", # Output only. [Output Only] URL of the region where the regional SSL policy # resides. This field is not applicable to global SSL policies. "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. @@ -808,8 +822,9 @@

Method Details

# lowercase letter, or digit, except the last character, which cannot be a # dash. "profile": "A String", # Profile specifies the set of SSL features that can be used by the load - # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features - # to enable must be specified in the customFeatures field. + # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED,FIPS_202205, or CUSTOM. If usingCUSTOM, the set of SSL features to enable must be specified in + # the customFeatures field. If using FIPS_202205, + # the min_tls_version field must be set to TLS_1_2. "region": "A String", # Output only. [Output Only] URL of the region where the regional SSL policy # resides. This field is not applicable to global SSL policies. "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. @@ -997,6 +1012,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1257,8 +1284,9 @@

Method Details

# lowercase letter, or digit, except the last character, which cannot be a # dash. "profile": "A String", # Profile specifies the set of SSL features that can be used by the load - # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features - # to enable must be specified in the customFeatures field. + # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED,FIPS_202205, or CUSTOM. If usingCUSTOM, the set of SSL features to enable must be specified in + # the customFeatures field. If using FIPS_202205, + # the min_tls_version field must be set to TLS_1_2. "region": "A String", # Output only. [Output Only] URL of the region where the regional SSL policy # resides. This field is not applicable to global SSL policies. "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. @@ -1497,8 +1525,9 @@

Method Details

# lowercase letter, or digit, except the last character, which cannot be a # dash. "profile": "A String", # Profile specifies the set of SSL features that can be used by the load - # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features - # to enable must be specified in the customFeatures field. + # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED,FIPS_202205, or CUSTOM. If usingCUSTOM, the set of SSL features to enable must be specified in + # the customFeatures field. If using FIPS_202205, + # the min_tls_version field must be set to TLS_1_2. "region": "A String", # Output only. [Output Only] URL of the region where the regional SSL policy # resides. This field is not applicable to global SSL policies. "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. @@ -1686,6 +1715,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.storagePools.html b/docs/dyn/compute_beta.storagePools.html index ab2358c91f..214d4bc15b 100644 --- a/docs/dyn/compute_beta.storagePools.html +++ b/docs/dyn/compute_beta.storagePools.html @@ -611,6 +611,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1536,6 +1548,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3322,6 +3346,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.subnetworks.html b/docs/dyn/compute_beta.subnetworks.html index 0e08aa7af1..e8832e9d2d 100644 --- a/docs/dyn/compute_beta.subnetworks.html +++ b/docs/dyn/compute_beta.subnetworks.html @@ -747,6 +747,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1038,6 +1050,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2224,6 +2248,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3414,6 +3450,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -4578,6 +4626,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.targetGrpcProxies.html b/docs/dyn/compute_beta.targetGrpcProxies.html index c39d614513..6571dcb98e 100644 --- a/docs/dyn/compute_beta.targetGrpcProxies.html +++ b/docs/dyn/compute_beta.targetGrpcProxies.html @@ -265,6 +265,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -654,6 +666,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1179,6 +1203,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.targetHttpProxies.html b/docs/dyn/compute_beta.targetHttpProxies.html index 36b193f37e..3078901947 100644 --- a/docs/dyn/compute_beta.targetHttpProxies.html +++ b/docs/dyn/compute_beta.targetHttpProxies.html @@ -551,6 +551,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1012,6 +1024,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1611,6 +1635,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1898,6 +1934,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.targetHttpsProxies.html b/docs/dyn/compute_beta.targetHttpsProxies.html index c2fa3434a5..43cd8244e5 100644 --- a/docs/dyn/compute_beta.targetHttpsProxies.html +++ b/docs/dyn/compute_beta.targetHttpsProxies.html @@ -661,6 +661,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1318,6 +1330,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2113,6 +2137,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2403,6 +2439,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2691,6 +2739,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2984,6 +3044,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3276,6 +3348,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3564,6 +3648,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.targetInstances.html b/docs/dyn/compute_beta.targetInstances.html index 24b001f95d..2e54799ae5 100644 --- a/docs/dyn/compute_beta.targetInstances.html +++ b/docs/dyn/compute_beta.targetInstances.html @@ -509,6 +509,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -896,6 +908,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1381,6 +1405,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.targetPools.html b/docs/dyn/compute_beta.targetPools.html index f4f8791e7b..817d41b495 100644 --- a/docs/dyn/compute_beta.targetPools.html +++ b/docs/dyn/compute_beta.targetPools.html @@ -301,6 +301,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -599,6 +611,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1154,6 +1178,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1655,6 +1691,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2183,6 +2231,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2476,6 +2536,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2765,6 +2837,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3056,6 +3140,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.targetSslProxies.html b/docs/dyn/compute_beta.targetSslProxies.html index 6cfe6d8a0d..9bbfd0c26c 100644 --- a/docs/dyn/compute_beta.targetSslProxies.html +++ b/docs/dyn/compute_beta.targetSslProxies.html @@ -277,6 +277,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -662,6 +674,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1143,6 +1167,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1433,6 +1469,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1721,6 +1769,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2013,6 +2073,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2305,6 +2377,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.targetTcpProxies.html b/docs/dyn/compute_beta.targetTcpProxies.html index d27a637b71..e828767d1d 100644 --- a/docs/dyn/compute_beta.targetTcpProxies.html +++ b/docs/dyn/compute_beta.targetTcpProxies.html @@ -511,6 +511,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -892,6 +904,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1371,6 +1395,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1659,6 +1695,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.targetVpnGateways.html b/docs/dyn/compute_beta.targetVpnGateways.html index 3f26c8c8a1..defa32fbbb 100644 --- a/docs/dyn/compute_beta.targetVpnGateways.html +++ b/docs/dyn/compute_beta.targetVpnGateways.html @@ -537,6 +537,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -980,6 +992,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1499,6 +1523,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.urlMaps.html b/docs/dyn/compute_beta.urlMaps.html index b8dac93024..7d94533c0d 100644 --- a/docs/dyn/compute_beta.urlMaps.html +++ b/docs/dyn/compute_beta.urlMaps.html @@ -4029,6 +4029,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -11436,6 +11448,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -11743,6 +11767,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -19287,6 +19323,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -23158,6 +23206,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.vpnGateways.html b/docs/dyn/compute_beta.vpnGateways.html index 718bba41b4..957d00d736 100644 --- a/docs/dyn/compute_beta.vpnGateways.html +++ b/docs/dyn/compute_beta.vpnGateways.html @@ -560,6 +560,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1092,6 +1104,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1631,6 +1655,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.vpnTunnels.html b/docs/dyn/compute_beta.vpnTunnels.html index 5e4debfccf..afaa404c75 100644 --- a/docs/dyn/compute_beta.vpnTunnels.html +++ b/docs/dyn/compute_beta.vpnTunnels.html @@ -634,6 +634,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1269,6 +1281,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1885,6 +1909,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.wireGroups.html b/docs/dyn/compute_beta.wireGroups.html index 79338f2505..7ff35a0019 100644 --- a/docs/dyn/compute_beta.wireGroups.html +++ b/docs/dyn/compute_beta.wireGroups.html @@ -264,6 +264,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -889,6 +901,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1656,6 +1680,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.zoneOperations.html b/docs/dyn/compute_beta.zoneOperations.html index ada83f9567..cd670efae2 100644 --- a/docs/dyn/compute_beta.zoneOperations.html +++ b/docs/dyn/compute_beta.zoneOperations.html @@ -264,6 +264,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -619,6 +631,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -952,6 +976,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_beta.zoneVmExtensionPolicies.html b/docs/dyn/compute_beta.zoneVmExtensionPolicies.html index 55742d6f74..b9954c7a10 100644 --- a/docs/dyn/compute_beta.zoneVmExtensionPolicies.html +++ b/docs/dyn/compute_beta.zoneVmExtensionPolicies.html @@ -263,6 +263,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -681,6 +693,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1243,6 +1267,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.addresses.html b/docs/dyn/compute_v1.addresses.html index b9743bb8a5..f2c15dca1c 100644 --- a/docs/dyn/compute_v1.addresses.html +++ b/docs/dyn/compute_v1.addresses.html @@ -582,6 +582,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1107,6 +1119,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1668,6 +1692,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1965,6 +2001,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.autoscalers.html b/docs/dyn/compute_v1.autoscalers.html index d028fb8265..8f87e712bb 100644 --- a/docs/dyn/compute_v1.autoscalers.html +++ b/docs/dyn/compute_v1.autoscalers.html @@ -803,6 +803,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1768,6 +1780,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2871,6 +2895,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3522,6 +3558,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.backendBuckets.html b/docs/dyn/compute_v1.backendBuckets.html index 19c32f3588..67b7109287 100644 --- a/docs/dyn/compute_v1.backendBuckets.html +++ b/docs/dyn/compute_v1.backendBuckets.html @@ -294,6 +294,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -579,6 +591,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -862,6 +886,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1905,6 +1941,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2717,6 +2765,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3005,6 +3065,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -4384,6 +4456,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.backendServices.html b/docs/dyn/compute_v1.backendServices.html index d1899e188d..800fc06154 100644 --- a/docs/dyn/compute_v1.backendServices.html +++ b/docs/dyn/compute_v1.backendServices.html @@ -315,6 +315,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1058,7 +1070,7 @@

Method Details

# draining traffic. A setting of false allows existing TCP # connections to persist, even on VMs no longer in the active pool, for up # to the duration of the connection draining timeout (10 minutes). - "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol isTCP. + "disableConnectionDrainOnFailover": True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. # # The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the @@ -2044,6 +2056,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2327,6 +2351,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2970,7 +3006,7 @@

Method Details

# draining traffic. A setting of false allows existing TCP # connections to persist, even on VMs no longer in the active pool, for up # to the duration of the connection draining timeout (10 minutes). - "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol isTCP. + "disableConnectionDrainOnFailover": True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. # # The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the @@ -4674,7 +4710,7 @@

Method Details

# draining traffic. A setting of false allows existing TCP # connections to persist, even on VMs no longer in the active pool, for up # to the duration of the connection draining timeout (10 minutes). - "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol isTCP. + "disableConnectionDrainOnFailover": True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. # # The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the @@ -5568,6 +5604,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6297,7 +6345,7 @@

Method Details

# draining traffic. A setting of false allows existing TCP # connections to persist, even on VMs no longer in the active pool, for up # to the duration of the connection draining timeout (10 minutes). - "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol isTCP. + "disableConnectionDrainOnFailover": True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. # # The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the @@ -7681,7 +7729,7 @@

Method Details

# draining traffic. A setting of false allows existing TCP # connections to persist, even on VMs no longer in the active pool, for up # to the duration of the connection draining timeout (10 minutes). - "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol isTCP. + "disableConnectionDrainOnFailover": True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. # # The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the @@ -9008,7 +9056,7 @@

Method Details

# draining traffic. A setting of false allows existing TCP # connections to persist, even on VMs no longer in the active pool, for up # to the duration of the connection draining timeout (10 minutes). - "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol isTCP. + "disableConnectionDrainOnFailover": True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. # # The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the @@ -9902,6 +9950,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -10190,6 +10250,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -11354,6 +11426,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -12027,7 +12111,7 @@

Method Details

# draining traffic. A setting of false allows existing TCP # connections to persist, even on VMs no longer in the active pool, for up # to the duration of the connection draining timeout (10 minutes). - "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol isTCP. + "disableConnectionDrainOnFailover": True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. # # The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the @@ -12921,6 +13005,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.crossSiteNetworks.html b/docs/dyn/compute_v1.crossSiteNetworks.html index 1534a1e214..2d74356cd5 100644 --- a/docs/dyn/compute_v1.crossSiteNetworks.html +++ b/docs/dyn/compute_v1.crossSiteNetworks.html @@ -263,6 +263,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -604,6 +616,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1087,6 +1111,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.disks.html b/docs/dyn/compute_v1.disks.html index b39fc5d394..8fcae5bac0 100644 --- a/docs/dyn/compute_v1.disks.html +++ b/docs/dyn/compute_v1.disks.html @@ -315,6 +315,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1317,6 +1329,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1618,6 +1642,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2228,6 +2264,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2513,6 +2561,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -4201,6 +4261,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5150,6 +5222,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5439,6 +5523,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6611,6 +6707,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6921,6 +7029,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -7203,6 +7323,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -7505,6 +7637,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -8334,6 +8478,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.externalVpnGateways.html b/docs/dyn/compute_v1.externalVpnGateways.html index 46e2307004..5d411b0422 100644 --- a/docs/dyn/compute_v1.externalVpnGateways.html +++ b/docs/dyn/compute_v1.externalVpnGateways.html @@ -265,6 +265,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -739,6 +751,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1264,6 +1288,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.firewallPolicies.html b/docs/dyn/compute_v1.firewallPolicies.html index b51a271666..e379e448c2 100644 --- a/docs/dyn/compute_v1.firewallPolicies.html +++ b/docs/dyn/compute_v1.firewallPolicies.html @@ -310,6 +310,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -761,6 +773,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1041,6 +1065,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1325,6 +1361,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3020,6 +3068,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3896,6 +3956,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -4587,6 +4659,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5039,6 +5123,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5319,6 +5415,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5599,6 +5707,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.firewalls.html b/docs/dyn/compute_v1.firewalls.html index e2cd68744d..1b18456e80 100644 --- a/docs/dyn/compute_v1.firewalls.html +++ b/docs/dyn/compute_v1.firewalls.html @@ -268,6 +268,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -897,6 +909,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1664,6 +1688,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2148,6 +2184,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.forwardingRules.html b/docs/dyn/compute_v1.forwardingRules.html index 9ea1dd2066..a6a999fb06 100644 --- a/docs/dyn/compute_v1.forwardingRules.html +++ b/docs/dyn/compute_v1.forwardingRules.html @@ -858,6 +858,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1937,6 +1949,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3154,6 +3178,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3452,6 +3488,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3741,6 +3789,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.futureReservations.html b/docs/dyn/compute_v1.futureReservations.html index 1bf5016f62..3f4e661e29 100644 --- a/docs/dyn/compute_v1.futureReservations.html +++ b/docs/dyn/compute_v1.futureReservations.html @@ -745,6 +745,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1031,6 +1043,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1895,6 +1919,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2901,6 +2937,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.globalAddresses.html b/docs/dyn/compute_v1.globalAddresses.html index 5f7179ace3..6adc2e6be8 100644 --- a/docs/dyn/compute_v1.globalAddresses.html +++ b/docs/dyn/compute_v1.globalAddresses.html @@ -268,6 +268,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -791,6 +803,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1349,6 +1373,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1635,6 +1671,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.globalForwardingRules.html b/docs/dyn/compute_v1.globalForwardingRules.html index e3e226fe64..16c8ca0c27 100644 --- a/docs/dyn/compute_v1.globalForwardingRules.html +++ b/docs/dyn/compute_v1.globalForwardingRules.html @@ -268,6 +268,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1346,6 +1358,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2561,6 +2585,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2848,6 +2884,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3136,6 +3184,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.globalNetworkEndpointGroups.html b/docs/dyn/compute_v1.globalNetworkEndpointGroups.html index 0c2b8705ae..3c1b024913 100644 --- a/docs/dyn/compute_v1.globalNetworkEndpointGroups.html +++ b/docs/dyn/compute_v1.globalNetworkEndpointGroups.html @@ -311,6 +311,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -598,6 +610,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -923,6 +947,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1548,6 +1584,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.globalOperations.html b/docs/dyn/compute_v1.globalOperations.html index 929f040d69..19d9fa35b2 100644 --- a/docs/dyn/compute_v1.globalOperations.html +++ b/docs/dyn/compute_v1.globalOperations.html @@ -347,6 +347,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -716,6 +728,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1070,6 +1094,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1403,6 +1439,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.globalOrganizationOperations.html b/docs/dyn/compute_v1.globalOrganizationOperations.html index 6193566b03..926d1edb20 100644 --- a/docs/dyn/compute_v1.globalOrganizationOperations.html +++ b/docs/dyn/compute_v1.globalOrganizationOperations.html @@ -260,6 +260,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -614,6 +626,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.globalPublicDelegatedPrefixes.html b/docs/dyn/compute_v1.globalPublicDelegatedPrefixes.html index b86287b4db..b2c6622444 100644 --- a/docs/dyn/compute_v1.globalPublicDelegatedPrefixes.html +++ b/docs/dyn/compute_v1.globalPublicDelegatedPrefixes.html @@ -262,6 +262,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -725,6 +737,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1325,6 +1349,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.healthChecks.html b/docs/dyn/compute_v1.healthChecks.html index d867d8e9e2..fbb89ac6fe 100644 --- a/docs/dyn/compute_v1.healthChecks.html +++ b/docs/dyn/compute_v1.healthChecks.html @@ -817,6 +817,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1812,6 +1824,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2944,6 +2968,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3609,6 +3645,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.html b/docs/dyn/compute_v1.html index 3877213856..6045d20c8e 100644 --- a/docs/dyn/compute_v1.html +++ b/docs/dyn/compute_v1.html @@ -374,6 +374,11 @@

Instance Methods

Returns the regionCommitments Resource.

+

+ regionCompositeHealthChecks() +

+

Returns the regionCompositeHealthChecks Resource.

+

regionDiskTypes()

@@ -399,6 +404,11 @@

Instance Methods

Returns the regionHealthChecks Resource.

+

+ regionHealthSources() +

+

Returns the regionHealthSources Resource.

+

regionInstanceGroupManagers()

diff --git a/docs/dyn/compute_v1.httpHealthChecks.html b/docs/dyn/compute_v1.httpHealthChecks.html index 043aef354d..cc65608eb2 100644 --- a/docs/dyn/compute_v1.httpHealthChecks.html +++ b/docs/dyn/compute_v1.httpHealthChecks.html @@ -268,6 +268,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -645,6 +657,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1159,6 +1183,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1515,6 +1551,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.httpsHealthChecks.html b/docs/dyn/compute_v1.httpsHealthChecks.html index 45bce1525d..e572fbffd7 100644 --- a/docs/dyn/compute_v1.httpsHealthChecks.html +++ b/docs/dyn/compute_v1.httpsHealthChecks.html @@ -268,6 +268,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -653,6 +665,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1175,6 +1199,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1535,6 +1571,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.images.html b/docs/dyn/compute_v1.images.html index c9d98606fb..07ed9304a5 100644 --- a/docs/dyn/compute_v1.images.html +++ b/docs/dyn/compute_v1.images.html @@ -280,6 +280,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -587,6 +599,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2648,6 +2672,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -4004,6 +4040,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5164,6 +5212,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.instanceGroupManagerResizeRequests.html b/docs/dyn/compute_v1.instanceGroupManagerResizeRequests.html index 214ce56da0..88113670dc 100644 --- a/docs/dyn/compute_v1.instanceGroupManagerResizeRequests.html +++ b/docs/dyn/compute_v1.instanceGroupManagerResizeRequests.html @@ -265,6 +265,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -557,6 +569,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1363,6 +1387,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.instanceGroupManagers.html b/docs/dyn/compute_v1.instanceGroupManagers.html index ec8229d71a..2651706438 100644 --- a/docs/dyn/compute_v1.instanceGroupManagers.html +++ b/docs/dyn/compute_v1.instanceGroupManagers.html @@ -352,6 +352,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -693,6 +705,11 @@

Method Details

# on resize events (depending on the value set inupdatePolicy.instanceRedistributionType). "zones": [ # Zones where the regional managed instance group will create and manage # its instances. + # By default, a regional MIG doesn't automatically select an AI zone to create + # instances, even if an AI zone is available in the specified region. To + # create instances in an AI zone in the selected region, you must explicitly + # specify it in the distribution policy together with the other preferred + # zones. { "zone": "A String", # The URL of thezone. # The zone must exist in the region where the managed instance group is @@ -849,8 +866,225 @@

Method Details

"effective": True or False, # Output only. [Output Only] A bit indicating whether this configuration has # been applied to all managed instances in the group. }, + "appliedAcceleratorTopologies": [ # Output only. [Output Only] The accelerator topology applied to this MIG. + # Currently only one accelerator topology is supported. + { + "acceleratorTopology": "A String", # Output only. [Output Only] Topology in the format of: "16x16", "4x4x4", etc. + # The value is the same as configured in the WorkloadPolicy. + "state": "A String", # Output only. [Output Only] The state of the accelerator topology. + "stateDetails": { # Output only. [Output Only] The result of the latest accelerator topology state + # check. + "error": { # Output only. [Output Only] Encountered errors. + "errors": [ # [Output Only] The array of errors encountered while processing this + # operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error + # details. There is a set of defined message types to use for providing + # details.The syntax depends on the error code. For example, + # QuotaExceededInfo will have details when the error code is + # QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. + # + # Example of an error when contacting the "pubsub.googleapis.com" API when it + # is not enabled: + # + # { "reason": "API_DISABLED" + # "domain": "googleapis.com" + # "metadata": { + # "resource": "projects/123", + # "service": "pubsub.googleapis.com" + # } + # } + # + # This response indicates that the pubsub.googleapis.com API is not enabled. + # + # Example of an error that is returned when attempting to create a Spanner + # instance in a region that is out of stock: + # + # { "reason": "STOCKOUT" + # "domain": "spanner.googleapis.com", + # "metadata": { + # "availableRegions": "us-central1,us-east2" + # } + # } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain + # is typically the registered service name of the tool or product that + # generates the error. Example: "pubsub.googleapis.com". If the error is + # generated by some common infrastructure, the error domain must be a + # globally unique value that identifies the infrastructure. For Google API + # infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. + # + # Keys must match a regular expression of `a-z+` but should + # ideally be lowerCamelCase. Also, they must be limited to 64 characters in + # length. When identifying the current value of an exceeded limit, the units + # should be contained in the key, not the value. For example, rather than + # `{"instanceLimit": "100/request"}`, should be returned as, + # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of + # instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the + # proximate cause of the error. Error reasons are unique within a particular + # domain of errors. This should be at most 63 characters and match a + # regular expression of `A-Z+[A-Z0-9]`, which represents + # UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. + # + # For example, if a quota check failed with an error indicating the calling + # project hasn't enabled the accessed service, this can contain a URL pointing + # directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user + # which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at + # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + # Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota + # type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type + # or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, + }, + ], + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. + # This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. + }, + ], + }, + "timestamp": "A String", # Output only. [Output Only] Timestamp is shown only if there is an error. The field + # has // RFC3339 // + # text format. + }, + }, + ], "autoscaler": "A String", # Output only. [Output Only] The URL of theAutoscaler # that targets this instance group manager. + "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. [Output Only] The status of bulk instance operation. + # targetSizePolicy.mode is set to BULK. + "inProgress": True or False, # Output only. [Output Only] Informs whether bulk instance operation is in progress. + "lastProgressCheck": { # Output only. [Output Only] Information from the last progress check of bulk instance + # operation. + "error": { # Output only. [Output Only] Errors encountered during bulk instance operation. + "errors": [ # [Output Only] The array of errors encountered while processing this + # operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error + # details. There is a set of defined message types to use for providing + # details.The syntax depends on the error code. For example, + # QuotaExceededInfo will have details when the error code is + # QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. + # + # Example of an error when contacting the "pubsub.googleapis.com" API when it + # is not enabled: + # + # { "reason": "API_DISABLED" + # "domain": "googleapis.com" + # "metadata": { + # "resource": "projects/123", + # "service": "pubsub.googleapis.com" + # } + # } + # + # This response indicates that the pubsub.googleapis.com API is not enabled. + # + # Example of an error that is returned when attempting to create a Spanner + # instance in a region that is out of stock: + # + # { "reason": "STOCKOUT" + # "domain": "spanner.googleapis.com", + # "metadata": { + # "availableRegions": "us-central1,us-east2" + # } + # } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain + # is typically the registered service name of the tool or product that + # generates the error. Example: "pubsub.googleapis.com". If the error is + # generated by some common infrastructure, the error domain must be a + # globally unique value that identifies the infrastructure. For Google API + # infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. + # + # Keys must match a regular expression of `a-z+` but should + # ideally be lowerCamelCase. Also, they must be limited to 64 characters in + # length. When identifying the current value of an exceeded limit, the units + # should be contained in the key, not the value. For example, rather than + # `{"instanceLimit": "100/request"}`, should be returned as, + # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of + # instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the + # proximate cause of the error. Error reasons are unique within a particular + # domain of errors. This should be at most 63 characters and match a + # regular expression of `A-Z+[A-Z0-9]`, which represents + # UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. + # + # For example, if a quota check failed with an error indicating the calling + # project hasn't enabled the accessed service, this can contain a URL pointing + # directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user + # which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at + # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + # Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota + # type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type + # or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, + }, + ], + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. + # This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. + }, + ], + }, + "timestamp": "A String", # Output only. [Output Only] Timestamp of the last progress check of bulk instance + # operation. Timestamp is in RFC3339 text format. + }, + }, "isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a # stable state. A stable state means that: none of the instances in the # managed instance group is currently undergoing any type of change (for @@ -886,6 +1120,11 @@

Method Details

# You can reduce this number by using the instanceGroupManager # deleteInstances or abandonInstances methods. Resizing the group also # changes this number. + "targetSizePolicy": { # The policy that specifies how the MIG creates its VMs to achieve the target + # size. + "mode": "A String", # The mode of target size policy based on which the MIG creates its VMs + # individually or all at once. + }, "targetStoppedSize": 42, # The target number of stopped instances for this managed instance group. # This number changes when you: # @@ -1334,6 +1573,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1699,6 +1950,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1984,6 +2247,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2299,6 +2574,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2582,6 +2869,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2824,6 +3123,11 @@

Method Details

# on resize events (depending on the value set inupdatePolicy.instanceRedistributionType). "zones": [ # Zones where the regional managed instance group will create and manage # its instances. + # By default, a regional MIG doesn't automatically select an AI zone to create + # instances, even if an AI zone is available in the specified region. To + # create instances in an AI zone in the selected region, you must explicitly + # specify it in the distribution policy together with the other preferred + # zones. { "zone": "A String", # The URL of thezone. # The zone must exist in the region where the managed instance group is @@ -2980,8 +3284,225 @@

Method Details

"effective": True or False, # Output only. [Output Only] A bit indicating whether this configuration has # been applied to all managed instances in the group. }, + "appliedAcceleratorTopologies": [ # Output only. [Output Only] The accelerator topology applied to this MIG. + # Currently only one accelerator topology is supported. + { + "acceleratorTopology": "A String", # Output only. [Output Only] Topology in the format of: "16x16", "4x4x4", etc. + # The value is the same as configured in the WorkloadPolicy. + "state": "A String", # Output only. [Output Only] The state of the accelerator topology. + "stateDetails": { # Output only. [Output Only] The result of the latest accelerator topology state + # check. + "error": { # Output only. [Output Only] Encountered errors. + "errors": [ # [Output Only] The array of errors encountered while processing this + # operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error + # details. There is a set of defined message types to use for providing + # details.The syntax depends on the error code. For example, + # QuotaExceededInfo will have details when the error code is + # QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. + # + # Example of an error when contacting the "pubsub.googleapis.com" API when it + # is not enabled: + # + # { "reason": "API_DISABLED" + # "domain": "googleapis.com" + # "metadata": { + # "resource": "projects/123", + # "service": "pubsub.googleapis.com" + # } + # } + # + # This response indicates that the pubsub.googleapis.com API is not enabled. + # + # Example of an error that is returned when attempting to create a Spanner + # instance in a region that is out of stock: + # + # { "reason": "STOCKOUT" + # "domain": "spanner.googleapis.com", + # "metadata": { + # "availableRegions": "us-central1,us-east2" + # } + # } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain + # is typically the registered service name of the tool or product that + # generates the error. Example: "pubsub.googleapis.com". If the error is + # generated by some common infrastructure, the error domain must be a + # globally unique value that identifies the infrastructure. For Google API + # infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. + # + # Keys must match a regular expression of `a-z+` but should + # ideally be lowerCamelCase. Also, they must be limited to 64 characters in + # length. When identifying the current value of an exceeded limit, the units + # should be contained in the key, not the value. For example, rather than + # `{"instanceLimit": "100/request"}`, should be returned as, + # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of + # instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the + # proximate cause of the error. Error reasons are unique within a particular + # domain of errors. This should be at most 63 characters and match a + # regular expression of `A-Z+[A-Z0-9]`, which represents + # UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. + # + # For example, if a quota check failed with an error indicating the calling + # project hasn't enabled the accessed service, this can contain a URL pointing + # directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user + # which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at + # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + # Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota + # type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type + # or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, + }, + ], + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. + # This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. + }, + ], + }, + "timestamp": "A String", # Output only. [Output Only] Timestamp is shown only if there is an error. The field + # has // RFC3339 // + # text format. + }, + }, + ], "autoscaler": "A String", # Output only. [Output Only] The URL of theAutoscaler # that targets this instance group manager. + "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. [Output Only] The status of bulk instance operation. + # targetSizePolicy.mode is set to BULK. + "inProgress": True or False, # Output only. [Output Only] Informs whether bulk instance operation is in progress. + "lastProgressCheck": { # Output only. [Output Only] Information from the last progress check of bulk instance + # operation. + "error": { # Output only. [Output Only] Errors encountered during bulk instance operation. + "errors": [ # [Output Only] The array of errors encountered while processing this + # operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error + # details. There is a set of defined message types to use for providing + # details.The syntax depends on the error code. For example, + # QuotaExceededInfo will have details when the error code is + # QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. + # + # Example of an error when contacting the "pubsub.googleapis.com" API when it + # is not enabled: + # + # { "reason": "API_DISABLED" + # "domain": "googleapis.com" + # "metadata": { + # "resource": "projects/123", + # "service": "pubsub.googleapis.com" + # } + # } + # + # This response indicates that the pubsub.googleapis.com API is not enabled. + # + # Example of an error that is returned when attempting to create a Spanner + # instance in a region that is out of stock: + # + # { "reason": "STOCKOUT" + # "domain": "spanner.googleapis.com", + # "metadata": { + # "availableRegions": "us-central1,us-east2" + # } + # } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain + # is typically the registered service name of the tool or product that + # generates the error. Example: "pubsub.googleapis.com". If the error is + # generated by some common infrastructure, the error domain must be a + # globally unique value that identifies the infrastructure. For Google API + # infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. + # + # Keys must match a regular expression of `a-z+` but should + # ideally be lowerCamelCase. Also, they must be limited to 64 characters in + # length. When identifying the current value of an exceeded limit, the units + # should be contained in the key, not the value. For example, rather than + # `{"instanceLimit": "100/request"}`, should be returned as, + # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of + # instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the + # proximate cause of the error. Error reasons are unique within a particular + # domain of errors. This should be at most 63 characters and match a + # regular expression of `A-Z+[A-Z0-9]`, which represents + # UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. + # + # For example, if a quota check failed with an error indicating the calling + # project hasn't enabled the accessed service, this can contain a URL pointing + # directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user + # which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at + # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + # Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota + # type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type + # or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, + }, + ], + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. + # This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. + }, + ], + }, + "timestamp": "A String", # Output only. [Output Only] Timestamp of the last progress check of bulk instance + # operation. Timestamp is in RFC3339 text format. + }, + }, "isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a # stable state. A stable state means that: none of the instances in the # managed instance group is currently undergoing any type of change (for @@ -3017,6 +3538,11 @@

Method Details

# You can reduce this number by using the instanceGroupManager # deleteInstances or abandonInstances methods. Resizing the group also # changes this number. + "targetSizePolicy": { # The policy that specifies how the MIG creates its VMs to achieve the target + # size. + "mode": "A String", # The mode of target size policy based on which the MIG creates its VMs + # individually or all at once. + }, "targetStoppedSize": 42, # The target number of stopped instances for this managed instance group. # This number changes when you: # @@ -3316,6 +3842,11 @@

Method Details

# on resize events (depending on the value set inupdatePolicy.instanceRedistributionType). "zones": [ # Zones where the regional managed instance group will create and manage # its instances. + # By default, a regional MIG doesn't automatically select an AI zone to create + # instances, even if an AI zone is available in the specified region. To + # create instances in an AI zone in the selected region, you must explicitly + # specify it in the distribution policy together with the other preferred + # zones. { "zone": "A String", # The URL of thezone. # The zone must exist in the region where the managed instance group is @@ -3472,8 +4003,225 @@

Method Details

"effective": True or False, # Output only. [Output Only] A bit indicating whether this configuration has # been applied to all managed instances in the group. }, + "appliedAcceleratorTopologies": [ # Output only. [Output Only] The accelerator topology applied to this MIG. + # Currently only one accelerator topology is supported. + { + "acceleratorTopology": "A String", # Output only. [Output Only] Topology in the format of: "16x16", "4x4x4", etc. + # The value is the same as configured in the WorkloadPolicy. + "state": "A String", # Output only. [Output Only] The state of the accelerator topology. + "stateDetails": { # Output only. [Output Only] The result of the latest accelerator topology state + # check. + "error": { # Output only. [Output Only] Encountered errors. + "errors": [ # [Output Only] The array of errors encountered while processing this + # operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error + # details. There is a set of defined message types to use for providing + # details.The syntax depends on the error code. For example, + # QuotaExceededInfo will have details when the error code is + # QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. + # + # Example of an error when contacting the "pubsub.googleapis.com" API when it + # is not enabled: + # + # { "reason": "API_DISABLED" + # "domain": "googleapis.com" + # "metadata": { + # "resource": "projects/123", + # "service": "pubsub.googleapis.com" + # } + # } + # + # This response indicates that the pubsub.googleapis.com API is not enabled. + # + # Example of an error that is returned when attempting to create a Spanner + # instance in a region that is out of stock: + # + # { "reason": "STOCKOUT" + # "domain": "spanner.googleapis.com", + # "metadata": { + # "availableRegions": "us-central1,us-east2" + # } + # } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain + # is typically the registered service name of the tool or product that + # generates the error. Example: "pubsub.googleapis.com". If the error is + # generated by some common infrastructure, the error domain must be a + # globally unique value that identifies the infrastructure. For Google API + # infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. + # + # Keys must match a regular expression of `a-z+` but should + # ideally be lowerCamelCase. Also, they must be limited to 64 characters in + # length. When identifying the current value of an exceeded limit, the units + # should be contained in the key, not the value. For example, rather than + # `{"instanceLimit": "100/request"}`, should be returned as, + # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of + # instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the + # proximate cause of the error. Error reasons are unique within a particular + # domain of errors. This should be at most 63 characters and match a + # regular expression of `A-Z+[A-Z0-9]`, which represents + # UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. + # + # For example, if a quota check failed with an error indicating the calling + # project hasn't enabled the accessed service, this can contain a URL pointing + # directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user + # which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at + # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + # Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota + # type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type + # or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, + }, + ], + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. + # This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. + }, + ], + }, + "timestamp": "A String", # Output only. [Output Only] Timestamp is shown only if there is an error. The field + # has // RFC3339 // + # text format. + }, + }, + ], "autoscaler": "A String", # Output only. [Output Only] The URL of theAutoscaler # that targets this instance group manager. + "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. [Output Only] The status of bulk instance operation. + # targetSizePolicy.mode is set to BULK. + "inProgress": True or False, # Output only. [Output Only] Informs whether bulk instance operation is in progress. + "lastProgressCheck": { # Output only. [Output Only] Information from the last progress check of bulk instance + # operation. + "error": { # Output only. [Output Only] Errors encountered during bulk instance operation. + "errors": [ # [Output Only] The array of errors encountered while processing this + # operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error + # details. There is a set of defined message types to use for providing + # details.The syntax depends on the error code. For example, + # QuotaExceededInfo will have details when the error code is + # QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. + # + # Example of an error when contacting the "pubsub.googleapis.com" API when it + # is not enabled: + # + # { "reason": "API_DISABLED" + # "domain": "googleapis.com" + # "metadata": { + # "resource": "projects/123", + # "service": "pubsub.googleapis.com" + # } + # } + # + # This response indicates that the pubsub.googleapis.com API is not enabled. + # + # Example of an error that is returned when attempting to create a Spanner + # instance in a region that is out of stock: + # + # { "reason": "STOCKOUT" + # "domain": "spanner.googleapis.com", + # "metadata": { + # "availableRegions": "us-central1,us-east2" + # } + # } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain + # is typically the registered service name of the tool or product that + # generates the error. Example: "pubsub.googleapis.com". If the error is + # generated by some common infrastructure, the error domain must be a + # globally unique value that identifies the infrastructure. For Google API + # infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. + # + # Keys must match a regular expression of `a-z+` but should + # ideally be lowerCamelCase. Also, they must be limited to 64 characters in + # length. When identifying the current value of an exceeded limit, the units + # should be contained in the key, not the value. For example, rather than + # `{"instanceLimit": "100/request"}`, should be returned as, + # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of + # instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the + # proximate cause of the error. Error reasons are unique within a particular + # domain of errors. This should be at most 63 characters and match a + # regular expression of `A-Z+[A-Z0-9]`, which represents + # UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. + # + # For example, if a quota check failed with an error indicating the calling + # project hasn't enabled the accessed service, this can contain a URL pointing + # directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user + # which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at + # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + # Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota + # type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type + # or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, + }, + ], + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. + # This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. + }, + ], + }, + "timestamp": "A String", # Output only. [Output Only] Timestamp of the last progress check of bulk instance + # operation. Timestamp is in RFC3339 text format. + }, + }, "isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a # stable state. A stable state means that: none of the instances in the # managed instance group is currently undergoing any type of change (for @@ -3509,6 +4257,11 @@

Method Details

# You can reduce this number by using the instanceGroupManager # deleteInstances or abandonInstances methods. Resizing the group also # changes this number. + "targetSizePolicy": { # The policy that specifies how the MIG creates its VMs to achieve the target + # size. + "mode": "A String", # The mode of target size policy based on which the MIG creates its VMs + # individually or all at once. + }, "targetStoppedSize": 42, # The target number of stopped instances for this managed instance group. # This number changes when you: # @@ -3834,6 +4587,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -4162,6 +4927,11 @@

Method Details

# on resize events (depending on the value set inupdatePolicy.instanceRedistributionType). "zones": [ # Zones where the regional managed instance group will create and manage # its instances. + # By default, a regional MIG doesn't automatically select an AI zone to create + # instances, even if an AI zone is available in the specified region. To + # create instances in an AI zone in the selected region, you must explicitly + # specify it in the distribution policy together with the other preferred + # zones. { "zone": "A String", # The URL of thezone. # The zone must exist in the region where the managed instance group is @@ -4318,8 +5088,225 @@

Method Details

"effective": True or False, # Output only. [Output Only] A bit indicating whether this configuration has # been applied to all managed instances in the group. }, + "appliedAcceleratorTopologies": [ # Output only. [Output Only] The accelerator topology applied to this MIG. + # Currently only one accelerator topology is supported. + { + "acceleratorTopology": "A String", # Output only. [Output Only] Topology in the format of: "16x16", "4x4x4", etc. + # The value is the same as configured in the WorkloadPolicy. + "state": "A String", # Output only. [Output Only] The state of the accelerator topology. + "stateDetails": { # Output only. [Output Only] The result of the latest accelerator topology state + # check. + "error": { # Output only. [Output Only] Encountered errors. + "errors": [ # [Output Only] The array of errors encountered while processing this + # operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error + # details. There is a set of defined message types to use for providing + # details.The syntax depends on the error code. For example, + # QuotaExceededInfo will have details when the error code is + # QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. + # + # Example of an error when contacting the "pubsub.googleapis.com" API when it + # is not enabled: + # + # { "reason": "API_DISABLED" + # "domain": "googleapis.com" + # "metadata": { + # "resource": "projects/123", + # "service": "pubsub.googleapis.com" + # } + # } + # + # This response indicates that the pubsub.googleapis.com API is not enabled. + # + # Example of an error that is returned when attempting to create a Spanner + # instance in a region that is out of stock: + # + # { "reason": "STOCKOUT" + # "domain": "spanner.googleapis.com", + # "metadata": { + # "availableRegions": "us-central1,us-east2" + # } + # } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain + # is typically the registered service name of the tool or product that + # generates the error. Example: "pubsub.googleapis.com". If the error is + # generated by some common infrastructure, the error domain must be a + # globally unique value that identifies the infrastructure. For Google API + # infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. + # + # Keys must match a regular expression of `a-z+` but should + # ideally be lowerCamelCase. Also, they must be limited to 64 characters in + # length. When identifying the current value of an exceeded limit, the units + # should be contained in the key, not the value. For example, rather than + # `{"instanceLimit": "100/request"}`, should be returned as, + # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of + # instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the + # proximate cause of the error. Error reasons are unique within a particular + # domain of errors. This should be at most 63 characters and match a + # regular expression of `A-Z+[A-Z0-9]`, which represents + # UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. + # + # For example, if a quota check failed with an error indicating the calling + # project hasn't enabled the accessed service, this can contain a URL pointing + # directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user + # which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at + # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + # Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota + # type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type + # or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, + }, + ], + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. + # This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. + }, + ], + }, + "timestamp": "A String", # Output only. [Output Only] Timestamp is shown only if there is an error. The field + # has // RFC3339 // + # text format. + }, + }, + ], "autoscaler": "A String", # Output only. [Output Only] The URL of theAutoscaler # that targets this instance group manager. + "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. [Output Only] The status of bulk instance operation. + # targetSizePolicy.mode is set to BULK. + "inProgress": True or False, # Output only. [Output Only] Informs whether bulk instance operation is in progress. + "lastProgressCheck": { # Output only. [Output Only] Information from the last progress check of bulk instance + # operation. + "error": { # Output only. [Output Only] Errors encountered during bulk instance operation. + "errors": [ # [Output Only] The array of errors encountered while processing this + # operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error + # details. There is a set of defined message types to use for providing + # details.The syntax depends on the error code. For example, + # QuotaExceededInfo will have details when the error code is + # QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. + # + # Example of an error when contacting the "pubsub.googleapis.com" API when it + # is not enabled: + # + # { "reason": "API_DISABLED" + # "domain": "googleapis.com" + # "metadata": { + # "resource": "projects/123", + # "service": "pubsub.googleapis.com" + # } + # } + # + # This response indicates that the pubsub.googleapis.com API is not enabled. + # + # Example of an error that is returned when attempting to create a Spanner + # instance in a region that is out of stock: + # + # { "reason": "STOCKOUT" + # "domain": "spanner.googleapis.com", + # "metadata": { + # "availableRegions": "us-central1,us-east2" + # } + # } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain + # is typically the registered service name of the tool or product that + # generates the error. Example: "pubsub.googleapis.com". If the error is + # generated by some common infrastructure, the error domain must be a + # globally unique value that identifies the infrastructure. For Google API + # infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. + # + # Keys must match a regular expression of `a-z+` but should + # ideally be lowerCamelCase. Also, they must be limited to 64 characters in + # length. When identifying the current value of an exceeded limit, the units + # should be contained in the key, not the value. For example, rather than + # `{"instanceLimit": "100/request"}`, should be returned as, + # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of + # instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the + # proximate cause of the error. Error reasons are unique within a particular + # domain of errors. This should be at most 63 characters and match a + # regular expression of `A-Z+[A-Z0-9]`, which represents + # UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. + # + # For example, if a quota check failed with an error indicating the calling + # project hasn't enabled the accessed service, this can contain a URL pointing + # directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user + # which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at + # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + # Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota + # type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type + # or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, + }, + ], + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. + # This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. + }, + ], + }, + "timestamp": "A String", # Output only. [Output Only] Timestamp of the last progress check of bulk instance + # operation. Timestamp is in RFC3339 text format. + }, + }, "isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a # stable state. A stable state means that: none of the instances in the # managed instance group is currently undergoing any type of change (for @@ -4355,6 +5342,11 @@

Method Details

# You can reduce this number by using the instanceGroupManager # deleteInstances or abandonInstances methods. Resizing the group also # changes this number. + "targetSizePolicy": { # The policy that specifies how the MIG creates its VMs to achieve the target + # size. + "mode": "A String", # The mode of target size policy based on which the MIG creates its VMs + # individually or all at once. + }, "targetStoppedSize": 42, # The target number of stopped instances for this managed instance group. # This number changes when you: # @@ -5469,6 +6461,11 @@

Method Details

# on resize events (depending on the value set inupdatePolicy.instanceRedistributionType). "zones": [ # Zones where the regional managed instance group will create and manage # its instances. + # By default, a regional MIG doesn't automatically select an AI zone to create + # instances, even if an AI zone is available in the specified region. To + # create instances in an AI zone in the selected region, you must explicitly + # specify it in the distribution policy together with the other preferred + # zones. { "zone": "A String", # The URL of thezone. # The zone must exist in the region where the managed instance group is @@ -5625,8 +6622,225 @@

Method Details

"effective": True or False, # Output only. [Output Only] A bit indicating whether this configuration has # been applied to all managed instances in the group. }, + "appliedAcceleratorTopologies": [ # Output only. [Output Only] The accelerator topology applied to this MIG. + # Currently only one accelerator topology is supported. + { + "acceleratorTopology": "A String", # Output only. [Output Only] Topology in the format of: "16x16", "4x4x4", etc. + # The value is the same as configured in the WorkloadPolicy. + "state": "A String", # Output only. [Output Only] The state of the accelerator topology. + "stateDetails": { # Output only. [Output Only] The result of the latest accelerator topology state + # check. + "error": { # Output only. [Output Only] Encountered errors. + "errors": [ # [Output Only] The array of errors encountered while processing this + # operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error + # details. There is a set of defined message types to use for providing + # details.The syntax depends on the error code. For example, + # QuotaExceededInfo will have details when the error code is + # QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. + # + # Example of an error when contacting the "pubsub.googleapis.com" API when it + # is not enabled: + # + # { "reason": "API_DISABLED" + # "domain": "googleapis.com" + # "metadata": { + # "resource": "projects/123", + # "service": "pubsub.googleapis.com" + # } + # } + # + # This response indicates that the pubsub.googleapis.com API is not enabled. + # + # Example of an error that is returned when attempting to create a Spanner + # instance in a region that is out of stock: + # + # { "reason": "STOCKOUT" + # "domain": "spanner.googleapis.com", + # "metadata": { + # "availableRegions": "us-central1,us-east2" + # } + # } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain + # is typically the registered service name of the tool or product that + # generates the error. Example: "pubsub.googleapis.com". If the error is + # generated by some common infrastructure, the error domain must be a + # globally unique value that identifies the infrastructure. For Google API + # infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. + # + # Keys must match a regular expression of `a-z+` but should + # ideally be lowerCamelCase. Also, they must be limited to 64 characters in + # length. When identifying the current value of an exceeded limit, the units + # should be contained in the key, not the value. For example, rather than + # `{"instanceLimit": "100/request"}`, should be returned as, + # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of + # instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the + # proximate cause of the error. Error reasons are unique within a particular + # domain of errors. This should be at most 63 characters and match a + # regular expression of `A-Z+[A-Z0-9]`, which represents + # UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. + # + # For example, if a quota check failed with an error indicating the calling + # project hasn't enabled the accessed service, this can contain a URL pointing + # directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user + # which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at + # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + # Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota + # type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type + # or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, + }, + ], + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. + # This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. + }, + ], + }, + "timestamp": "A String", # Output only. [Output Only] Timestamp is shown only if there is an error. The field + # has // RFC3339 // + # text format. + }, + }, + ], "autoscaler": "A String", # Output only. [Output Only] The URL of theAutoscaler # that targets this instance group manager. + "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. [Output Only] The status of bulk instance operation. + # targetSizePolicy.mode is set to BULK. + "inProgress": True or False, # Output only. [Output Only] Informs whether bulk instance operation is in progress. + "lastProgressCheck": { # Output only. [Output Only] Information from the last progress check of bulk instance + # operation. + "error": { # Output only. [Output Only] Errors encountered during bulk instance operation. + "errors": [ # [Output Only] The array of errors encountered while processing this + # operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error + # details. There is a set of defined message types to use for providing + # details.The syntax depends on the error code. For example, + # QuotaExceededInfo will have details when the error code is + # QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. + # + # Example of an error when contacting the "pubsub.googleapis.com" API when it + # is not enabled: + # + # { "reason": "API_DISABLED" + # "domain": "googleapis.com" + # "metadata": { + # "resource": "projects/123", + # "service": "pubsub.googleapis.com" + # } + # } + # + # This response indicates that the pubsub.googleapis.com API is not enabled. + # + # Example of an error that is returned when attempting to create a Spanner + # instance in a region that is out of stock: + # + # { "reason": "STOCKOUT" + # "domain": "spanner.googleapis.com", + # "metadata": { + # "availableRegions": "us-central1,us-east2" + # } + # } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain + # is typically the registered service name of the tool or product that + # generates the error. Example: "pubsub.googleapis.com". If the error is + # generated by some common infrastructure, the error domain must be a + # globally unique value that identifies the infrastructure. For Google API + # infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. + # + # Keys must match a regular expression of `a-z+` but should + # ideally be lowerCamelCase. Also, they must be limited to 64 characters in + # length. When identifying the current value of an exceeded limit, the units + # should be contained in the key, not the value. For example, rather than + # `{"instanceLimit": "100/request"}`, should be returned as, + # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of + # instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the + # proximate cause of the error. Error reasons are unique within a particular + # domain of errors. This should be at most 63 characters and match a + # regular expression of `A-Z+[A-Z0-9]`, which represents + # UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. + # + # For example, if a quota check failed with an error indicating the calling + # project hasn't enabled the accessed service, this can contain a URL pointing + # directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user + # which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at + # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + # Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota + # type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type + # or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, + }, + ], + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. + # This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. + }, + ], + }, + "timestamp": "A String", # Output only. [Output Only] Timestamp of the last progress check of bulk instance + # operation. Timestamp is in RFC3339 text format. + }, + }, "isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a # stable state. A stable state means that: none of the instances in the # managed instance group is currently undergoing any type of change (for @@ -5662,6 +6876,11 @@

Method Details

# You can reduce this number by using the instanceGroupManager # deleteInstances or abandonInstances methods. Resizing the group also # changes this number. + "targetSizePolicy": { # The policy that specifies how the MIG creates its VMs to achieve the target + # size. + "mode": "A String", # The mode of target size policy based on which the MIG creates its VMs + # individually or all at once. + }, "targetStoppedSize": 42, # The target number of stopped instances for this managed instance group. # This number changes when you: # @@ -5987,6 +7206,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6348,6 +7579,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6652,6 +7895,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6959,6 +8214,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -7266,6 +8533,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -7560,6 +8839,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -7865,6 +9156,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -8172,6 +9475,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -8490,6 +9805,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -8808,6 +10135,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -9169,6 +10508,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.instanceGroups.html b/docs/dyn/compute_v1.instanceGroups.html index 4c5c9221f9..32db766ef4 100644 --- a/docs/dyn/compute_v1.instanceGroups.html +++ b/docs/dyn/compute_v1.instanceGroups.html @@ -295,6 +295,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -841,6 +853,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1269,6 +1293,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1964,6 +2000,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2265,6 +2313,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.instanceSettings.html b/docs/dyn/compute_v1.instanceSettings.html index 0aab521ecd..e1f363d983 100644 --- a/docs/dyn/compute_v1.instanceSettings.html +++ b/docs/dyn/compute_v1.instanceSettings.html @@ -326,6 +326,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.instanceTemplates.html b/docs/dyn/compute_v1.instanceTemplates.html index 16e235a8dc..f781a83dff 100644 --- a/docs/dyn/compute_v1.instanceTemplates.html +++ b/docs/dyn/compute_v1.instanceTemplates.html @@ -1408,6 +1408,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3956,6 +3968,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.instances.html b/docs/dyn/compute_v1.instances.html index 3411443d67..c011337ce6 100644 --- a/docs/dyn/compute_v1.instances.html +++ b/docs/dyn/compute_v1.instances.html @@ -225,7 +225,7 @@

Instance Methods

testIamPermissions(project, zone, resource, body=None, x__xgafv=None)

Returns permissions that a caller has on the specified resource.

- update(project, zone, instance, body=None, minimalAction=None, mostDisruptiveAllowedAction=None, requestId=None, x__xgafv=None)

+ update(project, zone, instance, body=None, discardLocalSsd=None, minimalAction=None, mostDisruptiveAllowedAction=None, requestId=None, x__xgafv=None)

Updates an instance only if the necessary resources are available. This

updateAccessConfig(project, zone, instance, networkInterface, body=None, requestId=None, x__xgafv=None)

@@ -451,6 +451,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -913,6 +925,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1205,6 +1229,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3251,6 +3287,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -4937,6 +4985,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5224,6 +5284,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5507,6 +5579,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5794,6 +5878,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6077,6 +6173,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -9720,6 +9828,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -11451,6 +11571,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -11741,6 +11873,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -12035,6 +12179,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -12318,6 +12474,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -12600,6 +12768,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -12897,6 +13077,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -13181,6 +13373,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -14350,6 +14554,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -14650,6 +14866,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -14940,6 +15168,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -15253,6 +15493,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -15544,6 +15796,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -15834,6 +16098,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -16206,6 +16482,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -16504,6 +16792,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -16797,6 +17097,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -17090,6 +17402,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -17390,6 +17714,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -17674,6 +18010,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -17957,6 +18305,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -18316,6 +18676,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -18605,6 +18977,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -18896,6 +19280,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -19050,7 +19446,7 @@

Method Details

- update(project, zone, instance, body=None, minimalAction=None, mostDisruptiveAllowedAction=None, requestId=None, x__xgafv=None) + update(project, zone, instance, body=None, discardLocalSsd=None, minimalAction=None, mostDisruptiveAllowedAction=None, requestId=None, x__xgafv=None)
Updates an instance only if the necessary resources are available. This
 method can update only a specific set of instance properties. See
 Updating a running instance for a list of updatable instance
@@ -20193,6 +20589,8 @@ 

Method Details

# not settable as a field in the request body. } + discardLocalSsd: boolean, Whether to discard local SSDs from the instance during restart +default value is false. minimalAction: string, Specifies the action to take when updating an instance even if the updated properties do not require it. If not specified, then Compute Engine acts based on the minimum action that the updated @@ -20366,6 +20764,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -20699,6 +21109,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -20990,6 +21412,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -21457,6 +21891,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -21753,6 +22199,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.instantSnapshots.html b/docs/dyn/compute_v1.instantSnapshots.html index ba416d22b4..90e9747dd6 100644 --- a/docs/dyn/compute_v1.instantSnapshots.html +++ b/docs/dyn/compute_v1.instantSnapshots.html @@ -568,6 +568,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1413,6 +1425,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2825,6 +2849,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.interconnectAttachmentGroups.html b/docs/dyn/compute_v1.interconnectAttachmentGroups.html index 30d044357c..4680bfa516 100644 --- a/docs/dyn/compute_v1.interconnectAttachmentGroups.html +++ b/docs/dyn/compute_v1.interconnectAttachmentGroups.html @@ -275,6 +275,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1292,6 +1304,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1963,6 +1987,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.interconnectAttachments.html b/docs/dyn/compute_v1.interconnectAttachments.html index 5af4bdabc8..5188652f8e 100644 --- a/docs/dyn/compute_v1.interconnectAttachments.html +++ b/docs/dyn/compute_v1.interconnectAttachments.html @@ -845,6 +845,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1903,6 +1915,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3099,6 +3123,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3397,6 +3433,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.interconnectGroups.html b/docs/dyn/compute_v1.interconnectGroups.html index a0ff6fa9bf..29a6c52a88 100644 --- a/docs/dyn/compute_v1.interconnectGroups.html +++ b/docs/dyn/compute_v1.interconnectGroups.html @@ -399,6 +399,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -680,6 +692,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1769,6 +1793,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2427,6 +2463,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.interconnects.html b/docs/dyn/compute_v1.interconnects.html index d96e8a8577..71518f4b69 100644 --- a/docs/dyn/compute_v1.interconnects.html +++ b/docs/dyn/compute_v1.interconnects.html @@ -271,6 +271,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1282,6 +1294,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2275,6 +2299,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2562,6 +2598,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.licenses.html b/docs/dyn/compute_v1.licenses.html index 32531855b2..9d1bd07201 100644 --- a/docs/dyn/compute_v1.licenses.html +++ b/docs/dyn/compute_v1.licenses.html @@ -274,6 +274,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1111,6 +1123,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2629,6 +2653,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.machineImages.html b/docs/dyn/compute_v1.machineImages.html index badaab8d5e..a4a9d61b59 100644 --- a/docs/dyn/compute_v1.machineImages.html +++ b/docs/dyn/compute_v1.machineImages.html @@ -272,6 +272,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -4033,6 +4045,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6888,6 +6912,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.networkAttachments.html b/docs/dyn/compute_v1.networkAttachments.html index 767caebadd..41eaf49bd8 100644 --- a/docs/dyn/compute_v1.networkAttachments.html +++ b/docs/dyn/compute_v1.networkAttachments.html @@ -536,6 +536,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1337,6 +1349,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1905,6 +1929,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.networkEdgeSecurityServices.html b/docs/dyn/compute_v1.networkEdgeSecurityServices.html index de2a2229ff..624d0d6046 100644 --- a/docs/dyn/compute_v1.networkEdgeSecurityServices.html +++ b/docs/dyn/compute_v1.networkEdgeSecurityServices.html @@ -493,6 +493,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -861,6 +873,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1180,6 +1204,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.networkEndpointGroups.html b/docs/dyn/compute_v1.networkEndpointGroups.html index 8747aa4dae..b450fe57a7 100644 --- a/docs/dyn/compute_v1.networkEndpointGroups.html +++ b/docs/dyn/compute_v1.networkEndpointGroups.html @@ -674,6 +674,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -965,6 +977,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1293,6 +1317,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1923,6 +1959,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.networkFirewallPolicies.html b/docs/dyn/compute_v1.networkFirewallPolicies.html index cdef1531c7..21bf886f30 100644 --- a/docs/dyn/compute_v1.networkFirewallPolicies.html +++ b/docs/dyn/compute_v1.networkFirewallPolicies.html @@ -323,6 +323,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -779,6 +791,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1235,6 +1259,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2122,6 +2158,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2407,6 +2455,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -4290,6 +4350,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5539,6 +5611,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5992,6 +6076,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6445,6 +6541,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6726,6 +6834,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -7007,6 +7127,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -7288,6 +7420,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.networks.html b/docs/dyn/compute_v1.networks.html index 60928f4120..a0d1a728ae 100644 --- a/docs/dyn/compute_v1.networks.html +++ b/docs/dyn/compute_v1.networks.html @@ -373,6 +373,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -658,6 +670,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1853,6 +1877,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2815,6 +2851,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3102,6 +3150,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3390,6 +3450,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3670,6 +3742,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -4027,6 +4111,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.nodeGroups.html b/docs/dyn/compute_v1.nodeGroups.html index ed94b0528c..b468d4a78b 100644 --- a/docs/dyn/compute_v1.nodeGroups.html +++ b/docs/dyn/compute_v1.nodeGroups.html @@ -301,6 +301,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -862,6 +874,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1152,6 +1176,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1984,6 +2020,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2811,6 +2859,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3102,6 +3162,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -4266,6 +4338,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -4557,6 +4641,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.nodeTemplates.html b/docs/dyn/compute_v1.nodeTemplates.html index d604c6f98c..fdfb2cae2a 100644 --- a/docs/dyn/compute_v1.nodeTemplates.html +++ b/docs/dyn/compute_v1.nodeTemplates.html @@ -543,6 +543,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1359,6 +1371,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.organizationSecurityPolicies.html b/docs/dyn/compute_v1.organizationSecurityPolicies.html index f6a684c311..b4a60ff0a7 100644 --- a/docs/dyn/compute_v1.organizationSecurityPolicies.html +++ b/docs/dyn/compute_v1.organizationSecurityPolicies.html @@ -318,6 +318,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1011,6 +1023,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1301,6 +1325,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1584,6 +1620,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3594,6 +3642,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -4827,6 +4887,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5733,6 +5805,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6428,6 +6512,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6713,6 +6809,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6998,6 +7106,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.packetMirrorings.html b/docs/dyn/compute_v1.packetMirrorings.html index 0ad03edb99..6eb1c484d7 100644 --- a/docs/dyn/compute_v1.packetMirrorings.html +++ b/docs/dyn/compute_v1.packetMirrorings.html @@ -569,6 +569,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1076,6 +1088,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1721,6 +1745,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.previewFeatures.html b/docs/dyn/compute_v1.previewFeatures.html index cdc10701c8..b295585aab 100644 --- a/docs/dyn/compute_v1.previewFeatures.html +++ b/docs/dyn/compute_v1.previewFeatures.html @@ -597,6 +597,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.projects.html b/docs/dyn/compute_v1.projects.html index 0128a117dd..b325977df6 100644 --- a/docs/dyn/compute_v1.projects.html +++ b/docs/dyn/compute_v1.projects.html @@ -291,6 +291,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -583,6 +595,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -862,6 +886,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1155,6 +1191,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2047,6 +2095,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2350,6 +2410,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2639,6 +2711,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2950,6 +3034,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3238,6 +3334,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3534,6 +3642,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.publicAdvertisedPrefixes.html b/docs/dyn/compute_v1.publicAdvertisedPrefixes.html index 24f4f85c04..f573f32d71 100644 --- a/docs/dyn/compute_v1.publicAdvertisedPrefixes.html +++ b/docs/dyn/compute_v1.publicAdvertisedPrefixes.html @@ -263,6 +263,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -548,6 +560,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -987,6 +1011,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1562,6 +1598,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1842,6 +1890,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.publicDelegatedPrefixes.html b/docs/dyn/compute_v1.publicDelegatedPrefixes.html index c554292795..f8130c4ba2 100644 --- a/docs/dyn/compute_v1.publicDelegatedPrefixes.html +++ b/docs/dyn/compute_v1.publicDelegatedPrefixes.html @@ -550,6 +550,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -836,6 +848,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1301,6 +1325,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1903,6 +1939,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2185,6 +2233,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.regionAutoscalers.html b/docs/dyn/compute_v1.regionAutoscalers.html index 7fd0c4a666..08e0492157 100644 --- a/docs/dyn/compute_v1.regionAutoscalers.html +++ b/docs/dyn/compute_v1.regionAutoscalers.html @@ -269,6 +269,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1234,6 +1246,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2336,6 +2360,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2987,6 +3023,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.regionBackendServices.html b/docs/dyn/compute_v1.regionBackendServices.html index fe2ab92276..6c3eb50db2 100644 --- a/docs/dyn/compute_v1.regionBackendServices.html +++ b/docs/dyn/compute_v1.regionBackendServices.html @@ -287,6 +287,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -931,7 +943,7 @@

Method Details

# draining traffic. A setting of false allows existing TCP # connections to persist, even on VMs no longer in the active pool, for up # to the duration of the connection draining timeout (10 minutes). - "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol isTCP. + "disableConnectionDrainOnFailover": True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. # # The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the @@ -2618,7 +2630,7 @@

Method Details

# draining traffic. A setting of false allows existing TCP # connections to persist, even on VMs no longer in the active pool, for up # to the duration of the connection draining timeout (10 minutes). - "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol isTCP. + "disableConnectionDrainOnFailover": True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. # # The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the @@ -3512,6 +3524,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -4242,7 +4266,7 @@

Method Details

# draining traffic. A setting of false allows existing TCP # connections to persist, even on VMs no longer in the active pool, for up # to the duration of the connection draining timeout (10 minutes). - "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol isTCP. + "disableConnectionDrainOnFailover": True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. # # The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the @@ -5629,7 +5653,7 @@

Method Details

# draining traffic. A setting of false allows existing TCP # connections to persist, even on VMs no longer in the active pool, for up # to the duration of the connection draining timeout (10 minutes). - "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol isTCP. + "disableConnectionDrainOnFailover": True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. # # The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the @@ -6957,7 +6981,7 @@

Method Details

# draining traffic. A setting of false allows existing TCP # connections to persist, even on VMs no longer in the active pool, for up # to the duration of the connection draining timeout (10 minutes). - "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol isTCP. + "disableConnectionDrainOnFailover": True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. # # The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the @@ -7851,6 +7875,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -9017,6 +9053,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -9693,7 +9741,7 @@

Method Details

# draining traffic. A setting of false allows existing TCP # connections to persist, even on VMs no longer in the active pool, for up # to the duration of the connection draining timeout (10 minutes). - "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol isTCP. + "disableConnectionDrainOnFailover": True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. # # The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the @@ -10587,6 +10635,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.regionCommitments.html b/docs/dyn/compute_v1.regionCommitments.html index ef279c4920..1425c35009 100644 --- a/docs/dyn/compute_v1.regionCommitments.html +++ b/docs/dyn/compute_v1.regionCommitments.html @@ -1549,6 +1549,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2701,6 +2713,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.regionCompositeHealthChecks.html b/docs/dyn/compute_v1.regionCompositeHealthChecks.html new file mode 100644 index 0000000000..97ee12e229 --- /dev/null +++ b/docs/dyn/compute_v1.regionCompositeHealthChecks.html @@ -0,0 +1,1613 @@ + + + +

Compute Engine API . regionCompositeHealthChecks

+

Instance Methods

+

+ aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)

+

Retrieves the list of all CompositeHealthCheck resources (all

+

+ aggregatedList_next()

+

Retrieves the next page of results.

+

+ close()

+

Close httplib2 connections.

+

+ delete(project, region, compositeHealthCheck, requestId=None, x__xgafv=None)

+

Deletes the specified CompositeHealthCheck in the given region

+

+ get(project, region, compositeHealthCheck, x__xgafv=None)

+

Returns the specified CompositeHealthCheck resource in the given region.

+

+ insert(project, region, body=None, requestId=None, x__xgafv=None)

+

Create a CompositeHealthCheck in the specified project in the given region

+

+ list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists the CompositeHealthChecks for a project in the given region.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(project, region, compositeHealthCheck, body=None, requestId=None, x__xgafv=None)

+

Updates the specified regional CompositeHealthCheck resource

+

+ testIamPermissions(project, region, resource, body=None, x__xgafv=None)

+

Returns permissions that a caller has on the specified resource.

+

Method Details

+
+ aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None) +
Retrieves the list of all CompositeHealthCheck resources (all
+regional) available to the specified project.
+
+To prevent failure, it is recommended that you set the
+`returnPartialSuccess` parameter to `true`.
+
+Args:
+  project: string, Name of the project scoping this request. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most
+Compute resources support two types of filter expressions:
+expressions that support regular expressions and expressions that follow
+API improvement proposal AIP-160.
+These two types of filter expressions cannot be mixed in one request.
+
+If you want to use AIP-160, your expression must specify the field name, an
+operator, and the value that you want to use for filtering. The value
+must be a string, a number, or a boolean. The operator
+must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
+
+For example, if you are filtering Compute Engine instances, you can
+exclude instances named `example-instance` by specifying
+`name != example-instance`.
+
+The `:*` comparison can be used to test whether a key has been defined.
+For example, to find all objects with `owner` label use:
+```
+labels.owner:*
+```
+
+You can also filter nested fields. For example, you could specify
+`scheduling.automaticRestart = false` to include instances only
+if they are not scheduled for automatic restarts. You can use filtering
+on nested fields to filter based onresource labels.
+
+To filter on multiple expressions, provide each separate expression within
+parentheses. For example:
+```
+(scheduling.automaticRestart = true)
+(cpuPlatform = "Intel Skylake")
+```
+By default, each expression is an `AND` expression. However, you
+can include `AND` and `OR` expressions explicitly.
+For example:
+```
+(cpuPlatform = "Intel Skylake") OR
+(cpuPlatform = "Intel Broadwell") AND
+(scheduling.automaticRestart = true)
+```
+
+If you want to use a regular expression, use the `eq` (equal) or `ne`
+(not equal) operator against a single un-parenthesized expression with or
+without quotes or against multiple parenthesized expressions. Examples:
+
+`fieldname eq unquoted literal`
+`fieldname eq 'single quoted literal'`
+`fieldname eq "double quoted literal"`
+`(fieldname1 eq literal) (fieldname2 ne "literal")`
+
+The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
+The literal value must match the entire field.
+
+For example, to filter for instances that do not end with name "instance",
+you would use `name ne .*instance`.
+
+You cannot combine constraints on multiple fields using regular
+expressions.
+  includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
+global) should be included in the response. For new resource types added
+after this field, the flag has no effect as new resource types will always
+include every visible scope for each scope type in response. For resource
+types which predate this field, if this flag is omitted or false, only
+scopes of the scope types where the resource type is expected to be found
+will be included.
+  maxResults: integer, The maximum number of results per page that should be returned.
+If the number of available results is larger than `maxResults`,
+Compute Engine returns a `nextPageToken` that can be used to get
+the next page of results in subsequent list requests. Acceptable values are
+`0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results
+are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation
+timestamp using `orderBy="creationTimestamp desc"`. This sorts
+results based on the `creationTimestamp` field in
+reverse chronological order (newest result first). Use this to sort
+resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by `name` or
+`creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the
+`nextPageToken` returned by a previous list request to get
+the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
+of failure. The default value is false.
+
+For example, when partial success behavior is enabled, aggregatedList for a
+single zone scope either returns all resources in the zone or no resources,
+with an error code.
+  serviceProjectNumber: string, The Shared VPC service project id or service project number for which
+aggregated list request is invoked for subnetworks list-usable api.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Contains a list of CompositeHealthChecksScopedList.
+  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+  "items": { # A list of CompositeHealthChecksScopedList resources.
+    "a_key": { # Name of the scope containing this set of CompositeHealthChecks.
+      "compositeHealthChecks": [ # A list of CompositeHealthChecks contained in this scope.
+        { # Represents a composite health check.
+            #
+            # A composite health check resource specifies the health source resources and
+            # the health destination resource to which the aggregated health result from
+            # the health source resources is delivered.
+          "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+              # text format.
+          "description": "A String", # An optional description of this resource. Provide this property when you
+              # create the resource.
+          "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object.
+              # This field is used in optimistic locking. This field will be ignored when
+              # inserting a CompositeHealthCheck. An up-to-date fingerprint
+              # must be provided in order to patch the CompositeHealthCheck; Otherwise,
+              # the request will fail with error 412 conditionNotMet. To see
+              # the latest fingerprint, make a get() request to retrieve the
+              # CompositeHealthCheck.
+          "healthDestination": "A String", # URL to the destination resource. Must be set. Must be aForwardingRule. The ForwardingRule must have
+              # load balancing scheme INTERNAL orINTERNAL_MANAGED and must be regional and in the same region
+              # as the CompositeHealthCheck (cross-region deployment forINTERNAL_MANAGED is not supported). Can be mutated.
+          "healthSources": [ # URLs to the HealthSource resources whose results are AND'ed.
+              # I.e. he aggregated result is is HEALTHY only if all sources
+              # are HEALTHY. Must have at least 1. Must not have more than 10.
+              # Must be regional and in the same region as theCompositeHealthCheck. Can be mutated.
+            "A String",
+          ],
+          "id": "A String", # Output only. [Output Only] A unique identifier for this resource type. The server
+              # generates this identifier.
+          "kind": "compute#compositeHealthCheck", # Output only. [Output Only] Type of the resource. Alwayscompute#compositeHealthCheck for composite health checks.
+          "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+              # The name must be 1-63 characters long, and comply withRFC1035.
+              # Specifically, the name must be 1-63 characters long and match the regular
+              # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
+              # character must be a lowercase letter, and all following characters must
+              # be a dash, lowercase letter, or digit, except the last character, which
+              # cannot be a dash.
+          "region": "A String", # Output only. [Output Only] URL of the region where the composite health check resides.
+              # This field applies only to the regional resource. You must specify this
+              # field as part of the HTTP request URL. It is not settable as a field in
+              # the request body.
+          "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
+          "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL with id for the resource.
+        },
+      ],
+      "warning": { # Informational warning which replaces the list of composite health checks
+          # when the list is empty.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+            # Engine returns NO_RESULTS_ON_PAGE if there
+            # are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key:
+            # value format. For example:
+            #
+            # "data": [
+            #   {
+            #    "key": "scope",
+            #    "value": "zones/us-east1-d"
+            #   }
+          {
+            "key": "A String", # [Output Only] A key that provides more detail on the warning being
+                # returned. For example, for warnings where there are no results in a list
+                # request for a particular zone, this key might be scope and
+                # the key value might be the zone name. Other examples might be a key
+                # indicating a deprecated resource and a suggested replacement, or a
+                # warning about invalid network settings (for example, if an instance
+                # attempts to perform IP forwarding but is not enabled for IP forwarding).
+            "value": "A String", # [Output Only] A warning data value corresponding to the key.
+          },
+        ],
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+      },
+    },
+  },
+  "kind": "compute#compositeHealthCheckAggregatedList", # Output only. Type of resource.
+  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for
+      # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
+      # the query parameter pageToken in the next list request.
+      # Subsequent list requests will have their own nextPageToken to
+      # continue paging through the results.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined URL for this resource.
+  "unreachables": [ # Output only. [Output Only] Unreachable resources.
+    "A String",
+  ],
+  "warning": { # [Output Only] Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+        # Engine returns NO_RESULTS_ON_PAGE if there
+        # are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key:
+        # value format. For example:
+        #
+        # "data": [
+        #   {
+        #    "key": "scope",
+        #    "value": "zones/us-east1-d"
+        #   }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being
+            # returned. For example, for warnings where there are no results in a list
+            # request for a particular zone, this key might be scope and
+            # the key value might be the zone name. Other examples might be a key
+            # indicating a deprecated resource and a suggested replacement, or a
+            # warning about invalid network settings (for example, if an instance
+            # attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ aggregatedList_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.
+        
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ delete(project, region, compositeHealthCheck, requestId=None, x__xgafv=None) +
Deletes the specified CompositeHealthCheck in the given region
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region scoping this request. (required)
+  compositeHealthCheck: string, Name of the CompositeHealthCheck resource to delete. (required)
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/v1/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+          # name and the value is the version.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+          # component name and the value is the version.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ +
+ get(project, region, compositeHealthCheck, x__xgafv=None) +
Returns the specified CompositeHealthCheck resource in the given region.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region scoping this request. (required)
+  compositeHealthCheck: string, Name of the CompositeHealthCheck resource to return. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a composite health check.
+    #
+    # A composite health check resource specifies the health source resources and
+    # the health destination resource to which the aggregated health result from
+    # the health source resources is delivered.
+  "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+      # text format.
+  "description": "A String", # An optional description of this resource. Provide this property when you
+      # create the resource.
+  "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object.
+      # This field is used in optimistic locking. This field will be ignored when
+      # inserting a CompositeHealthCheck. An up-to-date fingerprint
+      # must be provided in order to patch the CompositeHealthCheck; Otherwise,
+      # the request will fail with error 412 conditionNotMet. To see
+      # the latest fingerprint, make a get() request to retrieve the
+      # CompositeHealthCheck.
+  "healthDestination": "A String", # URL to the destination resource. Must be set. Must be aForwardingRule. The ForwardingRule must have
+      # load balancing scheme INTERNAL orINTERNAL_MANAGED and must be regional and in the same region
+      # as the CompositeHealthCheck (cross-region deployment forINTERNAL_MANAGED is not supported). Can be mutated.
+  "healthSources": [ # URLs to the HealthSource resources whose results are AND'ed.
+      # I.e. he aggregated result is is HEALTHY only if all sources
+      # are HEALTHY. Must have at least 1. Must not have more than 10.
+      # Must be regional and in the same region as theCompositeHealthCheck. Can be mutated.
+    "A String",
+  ],
+  "id": "A String", # Output only. [Output Only] A unique identifier for this resource type. The server
+      # generates this identifier.
+  "kind": "compute#compositeHealthCheck", # Output only. [Output Only] Type of the resource. Alwayscompute#compositeHealthCheck for composite health checks.
+  "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+      # The name must be 1-63 characters long, and comply withRFC1035.
+      # Specifically, the name must be 1-63 characters long and match the regular
+      # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
+      # character must be a lowercase letter, and all following characters must
+      # be a dash, lowercase letter, or digit, except the last character, which
+      # cannot be a dash.
+  "region": "A String", # Output only. [Output Only] URL of the region where the composite health check resides.
+      # This field applies only to the regional resource. You must specify this
+      # field as part of the HTTP request URL. It is not settable as a field in
+      # the request body.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL with id for the resource.
+}
+
+ +
+ insert(project, region, body=None, requestId=None, x__xgafv=None) +
Create a CompositeHealthCheck in the specified project in the given region
+using the parameters that are included in the request.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region scoping this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a composite health check.
+    # 
+    # A composite health check resource specifies the health source resources and
+    # the health destination resource to which the aggregated health result from
+    # the health source resources is delivered.
+  "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+      # text format.
+  "description": "A String", # An optional description of this resource. Provide this property when you
+      # create the resource.
+  "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object.
+      # This field is used in optimistic locking. This field will be ignored when
+      # inserting a CompositeHealthCheck. An up-to-date fingerprint
+      # must be provided in order to patch the CompositeHealthCheck; Otherwise,
+      # the request will fail with error 412 conditionNotMet. To see
+      # the latest fingerprint, make a get() request to retrieve the
+      # CompositeHealthCheck.
+  "healthDestination": "A String", # URL to the destination resource. Must be set. Must be aForwardingRule. The ForwardingRule must have
+      # load balancing scheme INTERNAL orINTERNAL_MANAGED and must be regional and in the same region
+      # as the CompositeHealthCheck (cross-region deployment forINTERNAL_MANAGED is not supported). Can be mutated.
+  "healthSources": [ # URLs to the HealthSource resources whose results are AND'ed.
+      # I.e. he aggregated result is is HEALTHY only if all sources
+      # are HEALTHY. Must have at least 1. Must not have more than 10.
+      # Must be regional and in the same region as theCompositeHealthCheck. Can be mutated.
+    "A String",
+  ],
+  "id": "A String", # Output only. [Output Only] A unique identifier for this resource type. The server
+      # generates this identifier.
+  "kind": "compute#compositeHealthCheck", # Output only. [Output Only] Type of the resource. Alwayscompute#compositeHealthCheck for composite health checks.
+  "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+      # The name must be 1-63 characters long, and comply withRFC1035.
+      # Specifically, the name must be 1-63 characters long and match the regular
+      # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
+      # character must be a lowercase letter, and all following characters must
+      # be a dash, lowercase letter, or digit, except the last character, which
+      # cannot be a dash.
+  "region": "A String", # Output only. [Output Only] URL of the region where the composite health check resides.
+      # This field applies only to the regional resource. You must specify this
+      # field as part of the HTTP request URL. It is not settable as a field in
+      # the request body.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL with id for the resource.
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/v1/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+          # name and the value is the version.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+          # component name and the value is the version.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ +
+ list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Lists the CompositeHealthChecks for a project in the given region.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region scoping this request. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most
+Compute resources support two types of filter expressions:
+expressions that support regular expressions and expressions that follow
+API improvement proposal AIP-160.
+These two types of filter expressions cannot be mixed in one request.
+
+If you want to use AIP-160, your expression must specify the field name, an
+operator, and the value that you want to use for filtering. The value
+must be a string, a number, or a boolean. The operator
+must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
+
+For example, if you are filtering Compute Engine instances, you can
+exclude instances named `example-instance` by specifying
+`name != example-instance`.
+
+The `:*` comparison can be used to test whether a key has been defined.
+For example, to find all objects with `owner` label use:
+```
+labels.owner:*
+```
+
+You can also filter nested fields. For example, you could specify
+`scheduling.automaticRestart = false` to include instances only
+if they are not scheduled for automatic restarts. You can use filtering
+on nested fields to filter based onresource labels.
+
+To filter on multiple expressions, provide each separate expression within
+parentheses. For example:
+```
+(scheduling.automaticRestart = true)
+(cpuPlatform = "Intel Skylake")
+```
+By default, each expression is an `AND` expression. However, you
+can include `AND` and `OR` expressions explicitly.
+For example:
+```
+(cpuPlatform = "Intel Skylake") OR
+(cpuPlatform = "Intel Broadwell") AND
+(scheduling.automaticRestart = true)
+```
+
+If you want to use a regular expression, use the `eq` (equal) or `ne`
+(not equal) operator against a single un-parenthesized expression with or
+without quotes or against multiple parenthesized expressions. Examples:
+
+`fieldname eq unquoted literal`
+`fieldname eq 'single quoted literal'`
+`fieldname eq "double quoted literal"`
+`(fieldname1 eq literal) (fieldname2 ne "literal")`
+
+The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
+The literal value must match the entire field.
+
+For example, to filter for instances that do not end with name "instance",
+you would use `name ne .*instance`.
+
+You cannot combine constraints on multiple fields using regular
+expressions.
+  maxResults: integer, The maximum number of results per page that should be returned.
+If the number of available results is larger than `maxResults`,
+Compute Engine returns a `nextPageToken` that can be used to get
+the next page of results in subsequent list requests. Acceptable values are
+`0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results
+are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation
+timestamp using `orderBy="creationTimestamp desc"`. This sorts
+results based on the `creationTimestamp` field in
+reverse chronological order (newest result first). Use this to sort
+resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by `name` or
+`creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the
+`nextPageToken` returned by a previous list request to get
+the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
+of failure. The default value is false.
+
+For example, when partial success behavior is enabled, aggregatedList for a
+single zone scope either returns all resources in the zone or no resources,
+with an error code.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+  "items": [ # A list of CompositeHealthCheck resources.
+    { # Represents a composite health check.
+        #
+        # A composite health check resource specifies the health source resources and
+        # the health destination resource to which the aggregated health result from
+        # the health source resources is delivered.
+      "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+          # text format.
+      "description": "A String", # An optional description of this resource. Provide this property when you
+          # create the resource.
+      "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object.
+          # This field is used in optimistic locking. This field will be ignored when
+          # inserting a CompositeHealthCheck. An up-to-date fingerprint
+          # must be provided in order to patch the CompositeHealthCheck; Otherwise,
+          # the request will fail with error 412 conditionNotMet. To see
+          # the latest fingerprint, make a get() request to retrieve the
+          # CompositeHealthCheck.
+      "healthDestination": "A String", # URL to the destination resource. Must be set. Must be aForwardingRule. The ForwardingRule must have
+          # load balancing scheme INTERNAL orINTERNAL_MANAGED and must be regional and in the same region
+          # as the CompositeHealthCheck (cross-region deployment forINTERNAL_MANAGED is not supported). Can be mutated.
+      "healthSources": [ # URLs to the HealthSource resources whose results are AND'ed.
+          # I.e. he aggregated result is is HEALTHY only if all sources
+          # are HEALTHY. Must have at least 1. Must not have more than 10.
+          # Must be regional and in the same region as theCompositeHealthCheck. Can be mutated.
+        "A String",
+      ],
+      "id": "A String", # Output only. [Output Only] A unique identifier for this resource type. The server
+          # generates this identifier.
+      "kind": "compute#compositeHealthCheck", # Output only. [Output Only] Type of the resource. Alwayscompute#compositeHealthCheck for composite health checks.
+      "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+          # The name must be 1-63 characters long, and comply withRFC1035.
+          # Specifically, the name must be 1-63 characters long and match the regular
+          # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
+          # character must be a lowercase letter, and all following characters must
+          # be a dash, lowercase letter, or digit, except the last character, which
+          # cannot be a dash.
+      "region": "A String", # Output only. [Output Only] URL of the region where the composite health check resides.
+          # This field applies only to the regional resource. You must specify this
+          # field as part of the HTTP request URL. It is not settable as a field in
+          # the request body.
+      "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
+      "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL with id for the resource.
+    },
+  ],
+  "kind": "compute#compositeHealthCheckList", # Output only. [Output Only] Type of the resource. Alwayscompute#compositeHealthCheck for composite health checks.
+  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for
+      # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
+      # the query parameter pageToken in the next list request.
+      # Subsequent list requests will have their own nextPageToken to
+      # continue paging through the results.
+  "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+  "warning": { # [Output Only] Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+        # Engine returns NO_RESULTS_ON_PAGE if there
+        # are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key:
+        # value format. For example:
+        #
+        # "data": [
+        #   {
+        #    "key": "scope",
+        #    "value": "zones/us-east1-d"
+        #   }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being
+            # returned. For example, for warnings where there are no results in a list
+            # request for a particular zone, this key might be scope and
+            # the key value might be the zone name. Other examples might be a key
+            # indicating a deprecated resource and a suggested replacement, or a
+            # warning about invalid network settings (for example, if an instance
+            # attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(project, region, compositeHealthCheck, body=None, requestId=None, x__xgafv=None) +
Updates the specified regional CompositeHealthCheck resource
+with the data included in the request.  This method supportsPATCH
+semantics and uses theJSON merge
+patch format and processing rules.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region scoping this request. (required)
+  compositeHealthCheck: string, Name of the CompositeHealthCheck to update. The name
+must be 1-63 characters long, and comply with RFC1035. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a composite health check.
+    # 
+    # A composite health check resource specifies the health source resources and
+    # the health destination resource to which the aggregated health result from
+    # the health source resources is delivered.
+  "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+      # text format.
+  "description": "A String", # An optional description of this resource. Provide this property when you
+      # create the resource.
+  "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object.
+      # This field is used in optimistic locking. This field will be ignored when
+      # inserting a CompositeHealthCheck. An up-to-date fingerprint
+      # must be provided in order to patch the CompositeHealthCheck; Otherwise,
+      # the request will fail with error 412 conditionNotMet. To see
+      # the latest fingerprint, make a get() request to retrieve the
+      # CompositeHealthCheck.
+  "healthDestination": "A String", # URL to the destination resource. Must be set. Must be aForwardingRule. The ForwardingRule must have
+      # load balancing scheme INTERNAL orINTERNAL_MANAGED and must be regional and in the same region
+      # as the CompositeHealthCheck (cross-region deployment forINTERNAL_MANAGED is not supported). Can be mutated.
+  "healthSources": [ # URLs to the HealthSource resources whose results are AND'ed.
+      # I.e. he aggregated result is is HEALTHY only if all sources
+      # are HEALTHY. Must have at least 1. Must not have more than 10.
+      # Must be regional and in the same region as theCompositeHealthCheck. Can be mutated.
+    "A String",
+  ],
+  "id": "A String", # Output only. [Output Only] A unique identifier for this resource type. The server
+      # generates this identifier.
+  "kind": "compute#compositeHealthCheck", # Output only. [Output Only] Type of the resource. Alwayscompute#compositeHealthCheck for composite health checks.
+  "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+      # The name must be 1-63 characters long, and comply withRFC1035.
+      # Specifically, the name must be 1-63 characters long and match the regular
+      # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
+      # character must be a lowercase letter, and all following characters must
+      # be a dash, lowercase letter, or digit, except the last character, which
+      # cannot be a dash.
+  "region": "A String", # Output only. [Output Only] URL of the region where the composite health check resides.
+      # This field applies only to the regional resource. You must specify this
+      # field as part of the HTTP request URL. It is not settable as a field in
+      # the request body.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL with id for the resource.
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/v1/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+          # name and the value is the version.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+          # component name and the value is the version.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ +
+ testIamPermissions(project, region, 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)
+  region: string, The name of the region 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.regionDisks.html b/docs/dyn/compute_v1.regionDisks.html index e9d28a7e0f..f5558d6c60 100644 --- a/docs/dyn/compute_v1.regionDisks.html +++ b/docs/dyn/compute_v1.regionDisks.html @@ -305,6 +305,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -605,6 +617,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1213,6 +1237,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1498,6 +1534,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3183,6 +3231,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -4132,6 +4192,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -4420,6 +4492,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5591,6 +5675,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5901,6 +5997,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6183,6 +6291,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6485,6 +6605,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -7313,6 +7445,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.regionHealthAggregationPolicies.html b/docs/dyn/compute_v1.regionHealthAggregationPolicies.html index a9f7d1ac31..2bf85e3ebb 100644 --- a/docs/dyn/compute_v1.regionHealthAggregationPolicies.html +++ b/docs/dyn/compute_v1.regionHealthAggregationPolicies.html @@ -526,6 +526,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -945,6 +957,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1502,6 +1526,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.regionHealthCheckServices.html b/docs/dyn/compute_v1.regionHealthCheckServices.html index ca8e8f2151..e84976e39e 100644 --- a/docs/dyn/compute_v1.regionHealthCheckServices.html +++ b/docs/dyn/compute_v1.regionHealthCheckServices.html @@ -74,6 +74,12 @@

Compute Engine API . regionHealthCheckServices

Instance Methods

+

+ aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)

+

Retrieves the list of all HealthCheckService resources,

+

+ aggregatedList_next()

+

Retrieves the next page of results.

close()

Close httplib2 connections.

@@ -99,6 +105,262 @@

Instance Methods

testIamPermissions(project, region, resource, body=None, x__xgafv=None)

Returns permissions that a caller has on the specified resource.

Method Details

+
+ aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None) +
Retrieves the list of all HealthCheckService resources,
+regional and global, available to the specified project.
+
+To prevent failure, it is recommended that you set the
+`returnPartialSuccess` parameter to `true`.
+
+Args:
+  project: string, Name of the project scoping this request. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most
+Compute resources support two types of filter expressions:
+expressions that support regular expressions and expressions that follow
+API improvement proposal AIP-160.
+These two types of filter expressions cannot be mixed in one request.
+
+If you want to use AIP-160, your expression must specify the field name, an
+operator, and the value that you want to use for filtering. The value
+must be a string, a number, or a boolean. The operator
+must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
+
+For example, if you are filtering Compute Engine instances, you can
+exclude instances named `example-instance` by specifying
+`name != example-instance`.
+
+The `:*` comparison can be used to test whether a key has been defined.
+For example, to find all objects with `owner` label use:
+```
+labels.owner:*
+```
+
+You can also filter nested fields. For example, you could specify
+`scheduling.automaticRestart = false` to include instances only
+if they are not scheduled for automatic restarts. You can use filtering
+on nested fields to filter based onresource labels.
+
+To filter on multiple expressions, provide each separate expression within
+parentheses. For example:
+```
+(scheduling.automaticRestart = true)
+(cpuPlatform = "Intel Skylake")
+```
+By default, each expression is an `AND` expression. However, you
+can include `AND` and `OR` expressions explicitly.
+For example:
+```
+(cpuPlatform = "Intel Skylake") OR
+(cpuPlatform = "Intel Broadwell") AND
+(scheduling.automaticRestart = true)
+```
+
+If you want to use a regular expression, use the `eq` (equal) or `ne`
+(not equal) operator against a single un-parenthesized expression with or
+without quotes or against multiple parenthesized expressions. Examples:
+
+`fieldname eq unquoted literal`
+`fieldname eq 'single quoted literal'`
+`fieldname eq "double quoted literal"`
+`(fieldname1 eq literal) (fieldname2 ne "literal")`
+
+The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
+The literal value must match the entire field.
+
+For example, to filter for instances that do not end with name "instance",
+you would use `name ne .*instance`.
+
+You cannot combine constraints on multiple fields using regular
+expressions.
+  includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
+global) should be included in the response. For new resource types added
+after this field, the flag has no effect as new resource types will always
+include every visible scope for each scope type in response. For resource
+types which predate this field, if this flag is omitted or false, only
+scopes of the scope types where the resource type is expected to be found
+will be included.
+  maxResults: integer, The maximum number of results per page that should be returned.
+If the number of available results is larger than `maxResults`,
+Compute Engine returns a `nextPageToken` that can be used to get
+the next page of results in subsequent list requests. Acceptable values are
+`0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results
+are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation
+timestamp using `orderBy="creationTimestamp desc"`. This sorts
+results based on the `creationTimestamp` field in
+reverse chronological order (newest result first). Use this to sort
+resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by `name` or
+`creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the
+`nextPageToken` returned by a previous list request to get
+the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
+of failure. The default value is false.
+
+For example, when partial success behavior is enabled, aggregatedList for a
+single zone scope either returns all resources in the zone or no resources,
+with an error code.
+  serviceProjectNumber: string, The Shared VPC service project id or service project number for which
+aggregated list request is invoked for subnetworks list-usable api.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Contains a list of HealthCheckServicesScopedList.
+  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+  "items": { # A list of HealthCheckServicesScopedList resources.
+    "a_key": { # Name of the scope containing this set of HealthCheckServices.
+      "resources": [ # A list of HealthCheckServices contained in this scope.
+        { # Represents a Health-Check as a Service resource.
+          "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+              # text format.
+          "description": "A String", # An optional description of this resource. Provide this property when you
+              # create the resource.
+          "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object.
+              # This field is used in optimistic locking. This field will be ignored when
+              # inserting a HealthCheckService. An up-to-date fingerprint must
+              # be provided in order to patch/update the HealthCheckService; Otherwise, the
+              # request will fail with error 412 conditionNotMet. To see the
+              # latest fingerprint, make a get() request to retrieve the
+              # HealthCheckService.
+          "healthChecks": [ # A list of URLs to the HealthCheck resources. Must have
+              # at least one HealthCheck, and not more than 10 for regionalHealthCheckService, and not more than 1 for globalHealthCheckService.HealthCheck resources must haveportSpecification=USE_SERVING_PORT orportSpecification=USE_FIXED_PORT. For
+              # regional HealthCheckService, theHealthCheck must be regional and in the same
+              # region. For global HealthCheckService,HealthCheck must be global. Mix of regional and globalHealthChecks is not supported. Multiple regionalHealthChecks must belong to the same region. RegionalHealthChecks must belong to the same region as zones ofNetworkEndpointGroups. For globalHealthCheckService using globalINTERNET_IP_PORT NetworkEndpointGroups, the
+              # global HealthChecks must specify sourceRegions,
+              # and HealthChecks that specify sourceRegions can
+              # only be used with global INTERNET_IP_PORTNetworkEndpointGroups.
+            "A String",
+          ],
+          "healthStatusAggregationPolicy": "A String", # Optional. Policy for how the results from multiple health checks
+              # for the same endpoint are aggregated. Defaults to NO_AGGREGATION
+              # if unspecified.
+              #
+              #    - NO_AGGREGATION. An EndpointHealth message is
+              #    returned for each  pair in the health check
+              #    service.
+              #    - AND. If any health check of an endpoint reportsUNHEALTHY, then UNHEALTHY is theHealthState of the endpoint. If all health checks reportHEALTHY, the HealthState of the endpoint isHEALTHY.
+              #
+              # .
+              # This is only allowed with regional HealthCheckService.
+          "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+              # defined by the server.
+          "kind": "compute#healthCheckService", # Output only. [Output only] Type of the resource. Alwayscompute#healthCheckServicefor health check services.
+          "name": "A String", # Name of the resource. The name must be 1-63 characters long, and comply
+              # with RFC1035. Specifically, the name must be 1-63 characters
+              # long and match the regular expression
+              # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character
+              # must be a lowercase letter, and all following characters must be a dash,
+              # lowercase letter, or digit, except the last character, which cannot be a
+              # dash.
+          "networkEndpointGroups": [ # A list of URLs to the NetworkEndpointGroup
+              # resources. Must not have more than 100.  For regionalHealthCheckService, NEGs must be in
+              # zones in the region of the HealthCheckService. For globalHealthCheckServices, the NetworkEndpointGroups
+              # must be global INTERNET_IP_PORT.
+            "A String",
+          ],
+          "notificationEndpoints": [ # A list of URLs to the NotificationEndpoint
+              # resources. Must not have more than 10.  A list of endpoints for
+              # receiving notifications of change in health status. For regionalHealthCheckService,NotificationEndpoint must be regional and in the
+              # same region. For global HealthCheckService,NotificationEndpoint must be global.
+            "A String",
+          ],
+          "region": "A String", # Output only. [Output Only] URL of the region where the health check service
+              # resides. This field is not applicable to global health check services.
+              # You must specify this field as part of the HTTP request URL. It is
+              # not settable as a field in the request body.
+          "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
+        },
+      ],
+      "warning": { # Informational warning which replaces the list of
+          # backend services when the list is empty.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+            # Engine returns NO_RESULTS_ON_PAGE if there
+            # are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key:
+            # value format. For example:
+            #
+            # "data": [
+            #   {
+            #    "key": "scope",
+            #    "value": "zones/us-east1-d"
+            #   }
+          {
+            "key": "A String", # [Output Only] A key that provides more detail on the warning being
+                # returned. For example, for warnings where there are no results in a list
+                # request for a particular zone, this key might be scope and
+                # the key value might be the zone name. Other examples might be a key
+                # indicating a deprecated resource and a suggested replacement, or a
+                # warning about invalid network settings (for example, if an instance
+                # attempts to perform IP forwarding but is not enabled for IP forwarding).
+            "value": "A String", # [Output Only] A warning data value corresponding to the key.
+          },
+        ],
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+      },
+    },
+  },
+  "kind": "compute#healthCheckServiceAggregatedList", # Output only. Type of resource.
+  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for
+      # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
+      # the query parameter pageToken in the next list request.
+      # Subsequent list requests will have their own nextPageToken to
+      # continue paging through the results.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined URL for this resource.
+  "unreachables": [ # Output only. [Output Only] Unreachable resources.
+    "A String",
+  ],
+  "warning": { # [Output Only] Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+        # Engine returns NO_RESULTS_ON_PAGE if there
+        # are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key:
+        # value format. For example:
+        #
+        # "data": [
+        #   {
+        #    "key": "scope",
+        #    "value": "zones/us-east1-d"
+        #   }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being
+            # returned. For example, for warnings where there are no results in a list
+            # request for a particular zone, this key might be scope and
+            # the key value might be the zone name. Other examples might be a key
+            # indicating a deprecated resource and a suggested replacement, or a
+            # warning about invalid network settings (for example, if an instance
+            # attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ aggregatedList_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.
+        
+
+
close()
Close httplib2 connections.
@@ -267,6 +529,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -691,6 +965,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1253,6 +1539,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.regionHealthChecks.html b/docs/dyn/compute_v1.regionHealthChecks.html index 75621e7e72..63e71fd77f 100644 --- a/docs/dyn/compute_v1.regionHealthChecks.html +++ b/docs/dyn/compute_v1.regionHealthChecks.html @@ -269,6 +269,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1266,6 +1278,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2400,6 +2424,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3067,6 +3103,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.regionHealthSources.html b/docs/dyn/compute_v1.regionHealthSources.html new file mode 100644 index 0000000000..ffc70b3de4 --- /dev/null +++ b/docs/dyn/compute_v1.regionHealthSources.html @@ -0,0 +1,1628 @@ + + + +

Compute Engine API . regionHealthSources

+

Instance Methods

+

+ aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)

+

Retrieves the list of all HealthSource resources (all

+

+ aggregatedList_next()

+

Retrieves the next page of results.

+

+ close()

+

Close httplib2 connections.

+

+ delete(project, region, healthSource, requestId=None, x__xgafv=None)

+

Deletes the specified HealthSource in the given region

+

+ get(project, region, healthSource, x__xgafv=None)

+

Returns the specified HealthSource resource in the given region.

+

+ insert(project, region, body=None, requestId=None, x__xgafv=None)

+

Create a HealthSource in the specified project in the given region

+

+ list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists the HealthSources for a project in the given region.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(project, region, healthSource, body=None, requestId=None, x__xgafv=None)

+

Updates the specified regional HealthSource resource

+

+ testIamPermissions(project, region, resource, body=None, x__xgafv=None)

+

Returns permissions that a caller has on the specified resource.

+

Method Details

+
+ aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None) +
Retrieves the list of all HealthSource resources (all
+regional) available to the specified project.
+
+To prevent failure, Google recommends that you set the
+`returnPartialSuccess` parameter to `true`.
+
+Args:
+  project: string, Name of the project scoping this request. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most
+Compute resources support two types of filter expressions:
+expressions that support regular expressions and expressions that follow
+API improvement proposal AIP-160.
+These two types of filter expressions cannot be mixed in one request.
+
+If you want to use AIP-160, your expression must specify the field name, an
+operator, and the value that you want to use for filtering. The value
+must be a string, a number, or a boolean. The operator
+must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
+
+For example, if you are filtering Compute Engine instances, you can
+exclude instances named `example-instance` by specifying
+`name != example-instance`.
+
+The `:*` comparison can be used to test whether a key has been defined.
+For example, to find all objects with `owner` label use:
+```
+labels.owner:*
+```
+
+You can also filter nested fields. For example, you could specify
+`scheduling.automaticRestart = false` to include instances only
+if they are not scheduled for automatic restarts. You can use filtering
+on nested fields to filter based onresource labels.
+
+To filter on multiple expressions, provide each separate expression within
+parentheses. For example:
+```
+(scheduling.automaticRestart = true)
+(cpuPlatform = "Intel Skylake")
+```
+By default, each expression is an `AND` expression. However, you
+can include `AND` and `OR` expressions explicitly.
+For example:
+```
+(cpuPlatform = "Intel Skylake") OR
+(cpuPlatform = "Intel Broadwell") AND
+(scheduling.automaticRestart = true)
+```
+
+If you want to use a regular expression, use the `eq` (equal) or `ne`
+(not equal) operator against a single un-parenthesized expression with or
+without quotes or against multiple parenthesized expressions. Examples:
+
+`fieldname eq unquoted literal`
+`fieldname eq 'single quoted literal'`
+`fieldname eq "double quoted literal"`
+`(fieldname1 eq literal) (fieldname2 ne "literal")`
+
+The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
+The literal value must match the entire field.
+
+For example, to filter for instances that do not end with name "instance",
+you would use `name ne .*instance`.
+
+You cannot combine constraints on multiple fields using regular
+expressions.
+  includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
+global) should be included in the response. For new resource types added
+after this field, the flag has no effect as new resource types will always
+include every visible scope for each scope type in response. For resource
+types which predate this field, if this flag is omitted or false, only
+scopes of the scope types where the resource type is expected to be found
+will be included.
+  maxResults: integer, The maximum number of results per page that should be returned.
+If the number of available results is larger than `maxResults`,
+Compute Engine returns a `nextPageToken` that can be used to get
+the next page of results in subsequent list requests. Acceptable values are
+`0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results
+are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation
+timestamp using `orderBy="creationTimestamp desc"`. This sorts
+results based on the `creationTimestamp` field in
+reverse chronological order (newest result first). Use this to sort
+resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by `name` or
+`creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the
+`nextPageToken` returned by a previous list request to get
+the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
+of failure. The default value is false.
+
+For example, when partial success behavior is enabled, aggregatedList for a
+single zone scope either returns all resources in the zone or no resources,
+with an error code.
+  serviceProjectNumber: string, The Shared VPC service project id or service project number for which
+aggregated list request is invoked for subnetworks list-usable api.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Contains a list of HealthSourcesScopedList.
+  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+  "items": { # A list of HealthSourcesScopedList resources.
+    "a_key": { # Name of the scope containing this set of HealthSources.
+      "healthSources": [ # A list of HealthSources contained in this scope.
+        { # Represents a health source.
+            #
+            # A health source resource specifies the source resources and the health
+            # aggregation policy applied to the source resources to determine the
+            # aggregated health status.
+          "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+              # text format.
+          "description": "A String", # An optional description of this resource. Provide this property when you
+              # create the resource.
+          "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object.
+              # This field is used in optimistic locking. This field will be ignored when
+              # inserting a HealthSource. An up-to-date fingerprint
+              # must be provided in order to patch the HealthSource; Otherwise, the request
+              # will fail with error 412 conditionNotMet. To see the latest
+              # fingerprint, make a get() request to retrieve the
+              # HealthSource.
+          "healthAggregationPolicy": "A String", # URL to the HealthAggregationPolicy resource. Must be set. Must
+              # be regional and in the same region as the HealthSource. Can be
+              # mutated.
+          "id": "A String", # Output only. [Output Only] A unique identifier for this resource type. The server
+              # generates this identifier.
+          "kind": "compute#healthSource", # Output only. [Output Only] Type of the resource. Alwayscompute#healthSource for health sources.
+          "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+              # The name must be 1-63 characters long, and comply withRFC1035.
+              # Specifically, the name must be 1-63 characters long and match the regular
+              # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
+              # character must be a lowercase letter, and all following characters must
+              # be a dash, lowercase letter, or digit, except the last character, which
+              # cannot be a dash.
+          "region": "A String", # Output only. [Output Only] URL of the region where the health source resides.
+              # This field applies only to the regional resource. You must specify this
+              # field as part of the HTTP request URL. It is not settable as a field in
+              # the request body.
+          "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
+          "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL with id for the resource.
+          "sourceType": "A String", # Specifies the type of the HealthSource. The only allowed value
+              # is BACKEND_SERVICE. Must be specified when theHealthSource is created, and cannot be mutated.
+          "sources": [ # URLs to the source resources. Must be size 1. Must be aBackendService if
+              # the sourceType is BACKEND_SERVICE. TheBackendService must have load balancing schemeINTERNAL or INTERNAL_MANAGED and must be regional
+              # and in the same region as the HealthSource (cross-region
+              # deployment for INTERNAL_MANAGED is not supported). TheBackendService may use only IGs, MIGs, or NEGs of typeGCE_VM_IP or GCE_VM_IP_PORT. TheBackendService may not use haPolicy. Can be
+              # mutated.
+            "A String",
+          ],
+        },
+      ],
+      "warning": { # Informational warning which replaces the list of
+          # health sources when the list is empty.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+            # Engine returns NO_RESULTS_ON_PAGE if there
+            # are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key:
+            # value format. For example:
+            #
+            # "data": [
+            #   {
+            #    "key": "scope",
+            #    "value": "zones/us-east1-d"
+            #   }
+          {
+            "key": "A String", # [Output Only] A key that provides more detail on the warning being
+                # returned. For example, for warnings where there are no results in a list
+                # request for a particular zone, this key might be scope and
+                # the key value might be the zone name. Other examples might be a key
+                # indicating a deprecated resource and a suggested replacement, or a
+                # warning about invalid network settings (for example, if an instance
+                # attempts to perform IP forwarding but is not enabled for IP forwarding).
+            "value": "A String", # [Output Only] A warning data value corresponding to the key.
+          },
+        ],
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+      },
+    },
+  },
+  "kind": "compute#healthSourceAggregatedList", # Output only. Type of resource.
+  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for
+      # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
+      # the query parameter pageToken in the next list request.
+      # Subsequent list requests will have their own nextPageToken to
+      # continue paging through the results.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined URL for this resource.
+  "unreachables": [ # Output only. [Output Only] Unreachable resources.
+    "A String",
+  ],
+  "warning": { # [Output Only] Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+        # Engine returns NO_RESULTS_ON_PAGE if there
+        # are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key:
+        # value format. For example:
+        #
+        # "data": [
+        #   {
+        #    "key": "scope",
+        #    "value": "zones/us-east1-d"
+        #   }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being
+            # returned. For example, for warnings where there are no results in a list
+            # request for a particular zone, this key might be scope and
+            # the key value might be the zone name. Other examples might be a key
+            # indicating a deprecated resource and a suggested replacement, or a
+            # warning about invalid network settings (for example, if an instance
+            # attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ aggregatedList_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.
+        
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ delete(project, region, healthSource, requestId=None, x__xgafv=None) +
Deletes the specified HealthSource in the given region
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region scoping this request. (required)
+  healthSource: string, Name of the HealthSource resource to delete. (required)
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/v1/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+          # name and the value is the version.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+          # component name and the value is the version.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ +
+ get(project, region, healthSource, x__xgafv=None) +
Returns the specified HealthSource resource in the given region.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region scoping this request. (required)
+  healthSource: string, Name of the HealthSource resource to return. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a health source.
+    #
+    # A health source resource specifies the source resources and the health
+    # aggregation policy applied to the source resources to determine the
+    # aggregated health status.
+  "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+      # text format.
+  "description": "A String", # An optional description of this resource. Provide this property when you
+      # create the resource.
+  "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object.
+      # This field is used in optimistic locking. This field will be ignored when
+      # inserting a HealthSource. An up-to-date fingerprint
+      # must be provided in order to patch the HealthSource; Otherwise, the request
+      # will fail with error 412 conditionNotMet. To see the latest
+      # fingerprint, make a get() request to retrieve the
+      # HealthSource.
+  "healthAggregationPolicy": "A String", # URL to the HealthAggregationPolicy resource. Must be set. Must
+      # be regional and in the same region as the HealthSource. Can be
+      # mutated.
+  "id": "A String", # Output only. [Output Only] A unique identifier for this resource type. The server
+      # generates this identifier.
+  "kind": "compute#healthSource", # Output only. [Output Only] Type of the resource. Alwayscompute#healthSource for health sources.
+  "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+      # The name must be 1-63 characters long, and comply withRFC1035.
+      # Specifically, the name must be 1-63 characters long and match the regular
+      # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
+      # character must be a lowercase letter, and all following characters must
+      # be a dash, lowercase letter, or digit, except the last character, which
+      # cannot be a dash.
+  "region": "A String", # Output only. [Output Only] URL of the region where the health source resides.
+      # This field applies only to the regional resource. You must specify this
+      # field as part of the HTTP request URL. It is not settable as a field in
+      # the request body.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL with id for the resource.
+  "sourceType": "A String", # Specifies the type of the HealthSource. The only allowed value
+      # is BACKEND_SERVICE. Must be specified when theHealthSource is created, and cannot be mutated.
+  "sources": [ # URLs to the source resources. Must be size 1. Must be aBackendService if
+      # the sourceType is BACKEND_SERVICE. TheBackendService must have load balancing schemeINTERNAL or INTERNAL_MANAGED and must be regional
+      # and in the same region as the HealthSource (cross-region
+      # deployment for INTERNAL_MANAGED is not supported). TheBackendService may use only IGs, MIGs, or NEGs of typeGCE_VM_IP or GCE_VM_IP_PORT. TheBackendService may not use haPolicy. Can be
+      # mutated.
+    "A String",
+  ],
+}
+
+ +
+ insert(project, region, body=None, requestId=None, x__xgafv=None) +
Create a HealthSource in the specified project in the given region
+using the parameters that are included in the request.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region scoping this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a health source.
+    # 
+    # A health source resource specifies the source resources and the health
+    # aggregation policy applied to the source resources to determine the
+    # aggregated health status.
+  "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+      # text format.
+  "description": "A String", # An optional description of this resource. Provide this property when you
+      # create the resource.
+  "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object.
+      # This field is used in optimistic locking. This field will be ignored when
+      # inserting a HealthSource. An up-to-date fingerprint
+      # must be provided in order to patch the HealthSource; Otherwise, the request
+      # will fail with error 412 conditionNotMet. To see the latest
+      # fingerprint, make a get() request to retrieve the
+      # HealthSource.
+  "healthAggregationPolicy": "A String", # URL to the HealthAggregationPolicy resource. Must be set. Must
+      # be regional and in the same region as the HealthSource. Can be
+      # mutated.
+  "id": "A String", # Output only. [Output Only] A unique identifier for this resource type. The server
+      # generates this identifier.
+  "kind": "compute#healthSource", # Output only. [Output Only] Type of the resource. Alwayscompute#healthSource for health sources.
+  "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+      # The name must be 1-63 characters long, and comply withRFC1035.
+      # Specifically, the name must be 1-63 characters long and match the regular
+      # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
+      # character must be a lowercase letter, and all following characters must
+      # be a dash, lowercase letter, or digit, except the last character, which
+      # cannot be a dash.
+  "region": "A String", # Output only. [Output Only] URL of the region where the health source resides.
+      # This field applies only to the regional resource. You must specify this
+      # field as part of the HTTP request URL. It is not settable as a field in
+      # the request body.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL with id for the resource.
+  "sourceType": "A String", # Specifies the type of the HealthSource. The only allowed value
+      # is BACKEND_SERVICE. Must be specified when theHealthSource is created, and cannot be mutated.
+  "sources": [ # URLs to the source resources. Must be size 1. Must be aBackendService if
+      # the sourceType is BACKEND_SERVICE. TheBackendService must have load balancing schemeINTERNAL or INTERNAL_MANAGED and must be regional
+      # and in the same region as the HealthSource (cross-region
+      # deployment for INTERNAL_MANAGED is not supported). TheBackendService may use only IGs, MIGs, or NEGs of typeGCE_VM_IP or GCE_VM_IP_PORT. TheBackendService may not use haPolicy. Can be
+      # mutated.
+    "A String",
+  ],
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/v1/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+          # name and the value is the version.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+          # component name and the value is the version.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ +
+ list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Lists the HealthSources for a project in the given region.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region scoping this request. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most
+Compute resources support two types of filter expressions:
+expressions that support regular expressions and expressions that follow
+API improvement proposal AIP-160.
+These two types of filter expressions cannot be mixed in one request.
+
+If you want to use AIP-160, your expression must specify the field name, an
+operator, and the value that you want to use for filtering. The value
+must be a string, a number, or a boolean. The operator
+must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
+
+For example, if you are filtering Compute Engine instances, you can
+exclude instances named `example-instance` by specifying
+`name != example-instance`.
+
+The `:*` comparison can be used to test whether a key has been defined.
+For example, to find all objects with `owner` label use:
+```
+labels.owner:*
+```
+
+You can also filter nested fields. For example, you could specify
+`scheduling.automaticRestart = false` to include instances only
+if they are not scheduled for automatic restarts. You can use filtering
+on nested fields to filter based onresource labels.
+
+To filter on multiple expressions, provide each separate expression within
+parentheses. For example:
+```
+(scheduling.automaticRestart = true)
+(cpuPlatform = "Intel Skylake")
+```
+By default, each expression is an `AND` expression. However, you
+can include `AND` and `OR` expressions explicitly.
+For example:
+```
+(cpuPlatform = "Intel Skylake") OR
+(cpuPlatform = "Intel Broadwell") AND
+(scheduling.automaticRestart = true)
+```
+
+If you want to use a regular expression, use the `eq` (equal) or `ne`
+(not equal) operator against a single un-parenthesized expression with or
+without quotes or against multiple parenthesized expressions. Examples:
+
+`fieldname eq unquoted literal`
+`fieldname eq 'single quoted literal'`
+`fieldname eq "double quoted literal"`
+`(fieldname1 eq literal) (fieldname2 ne "literal")`
+
+The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
+The literal value must match the entire field.
+
+For example, to filter for instances that do not end with name "instance",
+you would use `name ne .*instance`.
+
+You cannot combine constraints on multiple fields using regular
+expressions.
+  maxResults: integer, The maximum number of results per page that should be returned.
+If the number of available results is larger than `maxResults`,
+Compute Engine returns a `nextPageToken` that can be used to get
+the next page of results in subsequent list requests. Acceptable values are
+`0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results
+are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation
+timestamp using `orderBy="creationTimestamp desc"`. This sorts
+results based on the `creationTimestamp` field in
+reverse chronological order (newest result first). Use this to sort
+resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by `name` or
+`creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the
+`nextPageToken` returned by a previous list request to get
+the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
+of failure. The default value is false.
+
+For example, when partial success behavior is enabled, aggregatedList for a
+single zone scope either returns all resources in the zone or no resources,
+with an error code.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+  "items": [ # A list of HealthSource resources.
+    { # Represents a health source.
+        #
+        # A health source resource specifies the source resources and the health
+        # aggregation policy applied to the source resources to determine the
+        # aggregated health status.
+      "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+          # text format.
+      "description": "A String", # An optional description of this resource. Provide this property when you
+          # create the resource.
+      "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object.
+          # This field is used in optimistic locking. This field will be ignored when
+          # inserting a HealthSource. An up-to-date fingerprint
+          # must be provided in order to patch the HealthSource; Otherwise, the request
+          # will fail with error 412 conditionNotMet. To see the latest
+          # fingerprint, make a get() request to retrieve the
+          # HealthSource.
+      "healthAggregationPolicy": "A String", # URL to the HealthAggregationPolicy resource. Must be set. Must
+          # be regional and in the same region as the HealthSource. Can be
+          # mutated.
+      "id": "A String", # Output only. [Output Only] A unique identifier for this resource type. The server
+          # generates this identifier.
+      "kind": "compute#healthSource", # Output only. [Output Only] Type of the resource. Alwayscompute#healthSource for health sources.
+      "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+          # The name must be 1-63 characters long, and comply withRFC1035.
+          # Specifically, the name must be 1-63 characters long and match the regular
+          # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
+          # character must be a lowercase letter, and all following characters must
+          # be a dash, lowercase letter, or digit, except the last character, which
+          # cannot be a dash.
+      "region": "A String", # Output only. [Output Only] URL of the region where the health source resides.
+          # This field applies only to the regional resource. You must specify this
+          # field as part of the HTTP request URL. It is not settable as a field in
+          # the request body.
+      "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
+      "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL with id for the resource.
+      "sourceType": "A String", # Specifies the type of the HealthSource. The only allowed value
+          # is BACKEND_SERVICE. Must be specified when theHealthSource is created, and cannot be mutated.
+      "sources": [ # URLs to the source resources. Must be size 1. Must be aBackendService if
+          # the sourceType is BACKEND_SERVICE. TheBackendService must have load balancing schemeINTERNAL or INTERNAL_MANAGED and must be regional
+          # and in the same region as the HealthSource (cross-region
+          # deployment for INTERNAL_MANAGED is not supported). TheBackendService may use only IGs, MIGs, or NEGs of typeGCE_VM_IP or GCE_VM_IP_PORT. TheBackendService may not use haPolicy. Can be
+          # mutated.
+        "A String",
+      ],
+    },
+  ],
+  "kind": "compute#healthSourceList", # Output only. [Output Only] Type of the resource. Alwayscompute#healthSource for health sources.
+  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for
+      # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
+      # the query parameter pageToken in the next list request.
+      # Subsequent list requests will have their own nextPageToken to
+      # continue paging through the results.
+  "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+  "warning": { # [Output Only] Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+        # Engine returns NO_RESULTS_ON_PAGE if there
+        # are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key:
+        # value format. For example:
+        #
+        # "data": [
+        #   {
+        #    "key": "scope",
+        #    "value": "zones/us-east1-d"
+        #   }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being
+            # returned. For example, for warnings where there are no results in a list
+            # request for a particular zone, this key might be scope and
+            # the key value might be the zone name. Other examples might be a key
+            # indicating a deprecated resource and a suggested replacement, or a
+            # warning about invalid network settings (for example, if an instance
+            # attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(project, region, healthSource, body=None, requestId=None, x__xgafv=None) +
Updates the specified regional HealthSource resource
+with the data included in the request.  This method supportsPATCH
+semantics and uses theJSON merge
+patch format and processing rules.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region scoping this request. (required)
+  healthSource: string, Name of the HealthSource to update. The name
+must be 1-63 characters long, and comply with RFC1035. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a health source.
+    # 
+    # A health source resource specifies the source resources and the health
+    # aggregation policy applied to the source resources to determine the
+    # aggregated health status.
+  "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+      # text format.
+  "description": "A String", # An optional description of this resource. Provide this property when you
+      # create the resource.
+  "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object.
+      # This field is used in optimistic locking. This field will be ignored when
+      # inserting a HealthSource. An up-to-date fingerprint
+      # must be provided in order to patch the HealthSource; Otherwise, the request
+      # will fail with error 412 conditionNotMet. To see the latest
+      # fingerprint, make a get() request to retrieve the
+      # HealthSource.
+  "healthAggregationPolicy": "A String", # URL to the HealthAggregationPolicy resource. Must be set. Must
+      # be regional and in the same region as the HealthSource. Can be
+      # mutated.
+  "id": "A String", # Output only. [Output Only] A unique identifier for this resource type. The server
+      # generates this identifier.
+  "kind": "compute#healthSource", # Output only. [Output Only] Type of the resource. Alwayscompute#healthSource for health sources.
+  "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+      # The name must be 1-63 characters long, and comply withRFC1035.
+      # Specifically, the name must be 1-63 characters long and match the regular
+      # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
+      # character must be a lowercase letter, and all following characters must
+      # be a dash, lowercase letter, or digit, except the last character, which
+      # cannot be a dash.
+  "region": "A String", # Output only. [Output Only] URL of the region where the health source resides.
+      # This field applies only to the regional resource. You must specify this
+      # field as part of the HTTP request URL. It is not settable as a field in
+      # the request body.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL with id for the resource.
+  "sourceType": "A String", # Specifies the type of the HealthSource. The only allowed value
+      # is BACKEND_SERVICE. Must be specified when theHealthSource is created, and cannot be mutated.
+  "sources": [ # URLs to the source resources. Must be size 1. Must be aBackendService if
+      # the sourceType is BACKEND_SERVICE. TheBackendService must have load balancing schemeINTERNAL or INTERNAL_MANAGED and must be regional
+      # and in the same region as the HealthSource (cross-region
+      # deployment for INTERNAL_MANAGED is not supported). TheBackendService may use only IGs, MIGs, or NEGs of typeGCE_VM_IP or GCE_VM_IP_PORT. TheBackendService may not use haPolicy. Can be
+      # mutated.
+    "A String",
+  ],
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/v1/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+          # name and the value is the version.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+          # component name and the value is the version.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ +
+ testIamPermissions(project, region, 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)
+  region: string, The name of the region 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.regionInstanceGroupManagers.html b/docs/dyn/compute_v1.regionInstanceGroupManagers.html index 5f17131aa1..b59ae1421f 100644 --- a/docs/dyn/compute_v1.regionInstanceGroupManagers.html +++ b/docs/dyn/compute_v1.regionInstanceGroupManagers.html @@ -345,6 +345,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -658,6 +670,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1025,6 +1049,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1307,6 +1343,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1619,6 +1667,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1898,6 +1958,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2139,6 +2211,11 @@

Method Details

# on resize events (depending on the value set inupdatePolicy.instanceRedistributionType). "zones": [ # Zones where the regional managed instance group will create and manage # its instances. + # By default, a regional MIG doesn't automatically select an AI zone to create + # instances, even if an AI zone is available in the specified region. To + # create instances in an AI zone in the selected region, you must explicitly + # specify it in the distribution policy together with the other preferred + # zones. { "zone": "A String", # The URL of thezone. # The zone must exist in the region where the managed instance group is @@ -2295,8 +2372,225 @@

Method Details

"effective": True or False, # Output only. [Output Only] A bit indicating whether this configuration has # been applied to all managed instances in the group. }, + "appliedAcceleratorTopologies": [ # Output only. [Output Only] The accelerator topology applied to this MIG. + # Currently only one accelerator topology is supported. + { + "acceleratorTopology": "A String", # Output only. [Output Only] Topology in the format of: "16x16", "4x4x4", etc. + # The value is the same as configured in the WorkloadPolicy. + "state": "A String", # Output only. [Output Only] The state of the accelerator topology. + "stateDetails": { # Output only. [Output Only] The result of the latest accelerator topology state + # check. + "error": { # Output only. [Output Only] Encountered errors. + "errors": [ # [Output Only] The array of errors encountered while processing this + # operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error + # details. There is a set of defined message types to use for providing + # details.The syntax depends on the error code. For example, + # QuotaExceededInfo will have details when the error code is + # QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. + # + # Example of an error when contacting the "pubsub.googleapis.com" API when it + # is not enabled: + # + # { "reason": "API_DISABLED" + # "domain": "googleapis.com" + # "metadata": { + # "resource": "projects/123", + # "service": "pubsub.googleapis.com" + # } + # } + # + # This response indicates that the pubsub.googleapis.com API is not enabled. + # + # Example of an error that is returned when attempting to create a Spanner + # instance in a region that is out of stock: + # + # { "reason": "STOCKOUT" + # "domain": "spanner.googleapis.com", + # "metadata": { + # "availableRegions": "us-central1,us-east2" + # } + # } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain + # is typically the registered service name of the tool or product that + # generates the error. Example: "pubsub.googleapis.com". If the error is + # generated by some common infrastructure, the error domain must be a + # globally unique value that identifies the infrastructure. For Google API + # infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. + # + # Keys must match a regular expression of `a-z+` but should + # ideally be lowerCamelCase. Also, they must be limited to 64 characters in + # length. When identifying the current value of an exceeded limit, the units + # should be contained in the key, not the value. For example, rather than + # `{"instanceLimit": "100/request"}`, should be returned as, + # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of + # instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the + # proximate cause of the error. Error reasons are unique within a particular + # domain of errors. This should be at most 63 characters and match a + # regular expression of `A-Z+[A-Z0-9]`, which represents + # UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. + # + # For example, if a quota check failed with an error indicating the calling + # project hasn't enabled the accessed service, this can contain a URL pointing + # directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user + # which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at + # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + # Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota + # type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type + # or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, + }, + ], + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. + # This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. + }, + ], + }, + "timestamp": "A String", # Output only. [Output Only] Timestamp is shown only if there is an error. The field + # has // RFC3339 // + # text format. + }, + }, + ], "autoscaler": "A String", # Output only. [Output Only] The URL of theAutoscaler # that targets this instance group manager. + "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. [Output Only] The status of bulk instance operation. + # targetSizePolicy.mode is set to BULK. + "inProgress": True or False, # Output only. [Output Only] Informs whether bulk instance operation is in progress. + "lastProgressCheck": { # Output only. [Output Only] Information from the last progress check of bulk instance + # operation. + "error": { # Output only. [Output Only] Errors encountered during bulk instance operation. + "errors": [ # [Output Only] The array of errors encountered while processing this + # operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error + # details. There is a set of defined message types to use for providing + # details.The syntax depends on the error code. For example, + # QuotaExceededInfo will have details when the error code is + # QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. + # + # Example of an error when contacting the "pubsub.googleapis.com" API when it + # is not enabled: + # + # { "reason": "API_DISABLED" + # "domain": "googleapis.com" + # "metadata": { + # "resource": "projects/123", + # "service": "pubsub.googleapis.com" + # } + # } + # + # This response indicates that the pubsub.googleapis.com API is not enabled. + # + # Example of an error that is returned when attempting to create a Spanner + # instance in a region that is out of stock: + # + # { "reason": "STOCKOUT" + # "domain": "spanner.googleapis.com", + # "metadata": { + # "availableRegions": "us-central1,us-east2" + # } + # } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain + # is typically the registered service name of the tool or product that + # generates the error. Example: "pubsub.googleapis.com". If the error is + # generated by some common infrastructure, the error domain must be a + # globally unique value that identifies the infrastructure. For Google API + # infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. + # + # Keys must match a regular expression of `a-z+` but should + # ideally be lowerCamelCase. Also, they must be limited to 64 characters in + # length. When identifying the current value of an exceeded limit, the units + # should be contained in the key, not the value. For example, rather than + # `{"instanceLimit": "100/request"}`, should be returned as, + # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of + # instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the + # proximate cause of the error. Error reasons are unique within a particular + # domain of errors. This should be at most 63 characters and match a + # regular expression of `A-Z+[A-Z0-9]`, which represents + # UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. + # + # For example, if a quota check failed with an error indicating the calling + # project hasn't enabled the accessed service, this can contain a URL pointing + # directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user + # which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at + # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + # Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota + # type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type + # or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, + }, + ], + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. + # This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. + }, + ], + }, + "timestamp": "A String", # Output only. [Output Only] Timestamp of the last progress check of bulk instance + # operation. Timestamp is in RFC3339 text format. + }, + }, "isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a # stable state. A stable state means that: none of the instances in the # managed instance group is currently undergoing any type of change (for @@ -2332,6 +2626,11 @@

Method Details

# You can reduce this number by using the instanceGroupManager # deleteInstances or abandonInstances methods. Resizing the group also # changes this number. + "targetSizePolicy": { # The policy that specifies how the MIG creates its VMs to achieve the target + # size. + "mode": "A String", # The mode of target size policy based on which the MIG creates its VMs + # individually or all at once. + }, "targetStoppedSize": 42, # The target number of stopped instances for this managed instance group. # This number changes when you: # @@ -2628,6 +2927,11 @@

Method Details

# on resize events (depending on the value set inupdatePolicy.instanceRedistributionType). "zones": [ # Zones where the regional managed instance group will create and manage # its instances. + # By default, a regional MIG doesn't automatically select an AI zone to create + # instances, even if an AI zone is available in the specified region. To + # create instances in an AI zone in the selected region, you must explicitly + # specify it in the distribution policy together with the other preferred + # zones. { "zone": "A String", # The URL of thezone. # The zone must exist in the region where the managed instance group is @@ -2784,8 +3088,225 @@

Method Details

"effective": True or False, # Output only. [Output Only] A bit indicating whether this configuration has # been applied to all managed instances in the group. }, + "appliedAcceleratorTopologies": [ # Output only. [Output Only] The accelerator topology applied to this MIG. + # Currently only one accelerator topology is supported. + { + "acceleratorTopology": "A String", # Output only. [Output Only] Topology in the format of: "16x16", "4x4x4", etc. + # The value is the same as configured in the WorkloadPolicy. + "state": "A String", # Output only. [Output Only] The state of the accelerator topology. + "stateDetails": { # Output only. [Output Only] The result of the latest accelerator topology state + # check. + "error": { # Output only. [Output Only] Encountered errors. + "errors": [ # [Output Only] The array of errors encountered while processing this + # operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error + # details. There is a set of defined message types to use for providing + # details.The syntax depends on the error code. For example, + # QuotaExceededInfo will have details when the error code is + # QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. + # + # Example of an error when contacting the "pubsub.googleapis.com" API when it + # is not enabled: + # + # { "reason": "API_DISABLED" + # "domain": "googleapis.com" + # "metadata": { + # "resource": "projects/123", + # "service": "pubsub.googleapis.com" + # } + # } + # + # This response indicates that the pubsub.googleapis.com API is not enabled. + # + # Example of an error that is returned when attempting to create a Spanner + # instance in a region that is out of stock: + # + # { "reason": "STOCKOUT" + # "domain": "spanner.googleapis.com", + # "metadata": { + # "availableRegions": "us-central1,us-east2" + # } + # } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain + # is typically the registered service name of the tool or product that + # generates the error. Example: "pubsub.googleapis.com". If the error is + # generated by some common infrastructure, the error domain must be a + # globally unique value that identifies the infrastructure. For Google API + # infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. + # + # Keys must match a regular expression of `a-z+` but should + # ideally be lowerCamelCase. Also, they must be limited to 64 characters in + # length. When identifying the current value of an exceeded limit, the units + # should be contained in the key, not the value. For example, rather than + # `{"instanceLimit": "100/request"}`, should be returned as, + # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of + # instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the + # proximate cause of the error. Error reasons are unique within a particular + # domain of errors. This should be at most 63 characters and match a + # regular expression of `A-Z+[A-Z0-9]`, which represents + # UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. + # + # For example, if a quota check failed with an error indicating the calling + # project hasn't enabled the accessed service, this can contain a URL pointing + # directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user + # which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at + # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + # Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota + # type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type + # or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, + }, + ], + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. + # This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. + }, + ], + }, + "timestamp": "A String", # Output only. [Output Only] Timestamp is shown only if there is an error. The field + # has // RFC3339 // + # text format. + }, + }, + ], "autoscaler": "A String", # Output only. [Output Only] The URL of theAutoscaler # that targets this instance group manager. + "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. [Output Only] The status of bulk instance operation. + # targetSizePolicy.mode is set to BULK. + "inProgress": True or False, # Output only. [Output Only] Informs whether bulk instance operation is in progress. + "lastProgressCheck": { # Output only. [Output Only] Information from the last progress check of bulk instance + # operation. + "error": { # Output only. [Output Only] Errors encountered during bulk instance operation. + "errors": [ # [Output Only] The array of errors encountered while processing this + # operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error + # details. There is a set of defined message types to use for providing + # details.The syntax depends on the error code. For example, + # QuotaExceededInfo will have details when the error code is + # QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. + # + # Example of an error when contacting the "pubsub.googleapis.com" API when it + # is not enabled: + # + # { "reason": "API_DISABLED" + # "domain": "googleapis.com" + # "metadata": { + # "resource": "projects/123", + # "service": "pubsub.googleapis.com" + # } + # } + # + # This response indicates that the pubsub.googleapis.com API is not enabled. + # + # Example of an error that is returned when attempting to create a Spanner + # instance in a region that is out of stock: + # + # { "reason": "STOCKOUT" + # "domain": "spanner.googleapis.com", + # "metadata": { + # "availableRegions": "us-central1,us-east2" + # } + # } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain + # is typically the registered service name of the tool or product that + # generates the error. Example: "pubsub.googleapis.com". If the error is + # generated by some common infrastructure, the error domain must be a + # globally unique value that identifies the infrastructure. For Google API + # infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. + # + # Keys must match a regular expression of `a-z+` but should + # ideally be lowerCamelCase. Also, they must be limited to 64 characters in + # length. When identifying the current value of an exceeded limit, the units + # should be contained in the key, not the value. For example, rather than + # `{"instanceLimit": "100/request"}`, should be returned as, + # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of + # instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the + # proximate cause of the error. Error reasons are unique within a particular + # domain of errors. This should be at most 63 characters and match a + # regular expression of `A-Z+[A-Z0-9]`, which represents + # UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. + # + # For example, if a quota check failed with an error indicating the calling + # project hasn't enabled the accessed service, this can contain a URL pointing + # directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user + # which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at + # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + # Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota + # type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type + # or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, + }, + ], + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. + # This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. + }, + ], + }, + "timestamp": "A String", # Output only. [Output Only] Timestamp of the last progress check of bulk instance + # operation. Timestamp is in RFC3339 text format. + }, + }, "isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a # stable state. A stable state means that: none of the instances in the # managed instance group is currently undergoing any type of change (for @@ -2821,6 +3342,11 @@

Method Details

# You can reduce this number by using the instanceGroupManager # deleteInstances or abandonInstances methods. Resizing the group also # changes this number. + "targetSizePolicy": { # The policy that specifies how the MIG creates its VMs to achieve the target + # size. + "mode": "A String", # The mode of target size policy based on which the MIG creates its VMs + # individually or all at once. + }, "targetStoppedSize": 42, # The target number of stopped instances for this managed instance group. # This number changes when you: # @@ -3146,6 +3672,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3473,6 +4011,11 @@

Method Details

# on resize events (depending on the value set inupdatePolicy.instanceRedistributionType). "zones": [ # Zones where the regional managed instance group will create and manage # its instances. + # By default, a regional MIG doesn't automatically select an AI zone to create + # instances, even if an AI zone is available in the specified region. To + # create instances in an AI zone in the selected region, you must explicitly + # specify it in the distribution policy together with the other preferred + # zones. { "zone": "A String", # The URL of thezone. # The zone must exist in the region where the managed instance group is @@ -3629,8 +4172,225 @@

Method Details

"effective": True or False, # Output only. [Output Only] A bit indicating whether this configuration has # been applied to all managed instances in the group. }, + "appliedAcceleratorTopologies": [ # Output only. [Output Only] The accelerator topology applied to this MIG. + # Currently only one accelerator topology is supported. + { + "acceleratorTopology": "A String", # Output only. [Output Only] Topology in the format of: "16x16", "4x4x4", etc. + # The value is the same as configured in the WorkloadPolicy. + "state": "A String", # Output only. [Output Only] The state of the accelerator topology. + "stateDetails": { # Output only. [Output Only] The result of the latest accelerator topology state + # check. + "error": { # Output only. [Output Only] Encountered errors. + "errors": [ # [Output Only] The array of errors encountered while processing this + # operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error + # details. There is a set of defined message types to use for providing + # details.The syntax depends on the error code. For example, + # QuotaExceededInfo will have details when the error code is + # QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. + # + # Example of an error when contacting the "pubsub.googleapis.com" API when it + # is not enabled: + # + # { "reason": "API_DISABLED" + # "domain": "googleapis.com" + # "metadata": { + # "resource": "projects/123", + # "service": "pubsub.googleapis.com" + # } + # } + # + # This response indicates that the pubsub.googleapis.com API is not enabled. + # + # Example of an error that is returned when attempting to create a Spanner + # instance in a region that is out of stock: + # + # { "reason": "STOCKOUT" + # "domain": "spanner.googleapis.com", + # "metadata": { + # "availableRegions": "us-central1,us-east2" + # } + # } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain + # is typically the registered service name of the tool or product that + # generates the error. Example: "pubsub.googleapis.com". If the error is + # generated by some common infrastructure, the error domain must be a + # globally unique value that identifies the infrastructure. For Google API + # infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. + # + # Keys must match a regular expression of `a-z+` but should + # ideally be lowerCamelCase. Also, they must be limited to 64 characters in + # length. When identifying the current value of an exceeded limit, the units + # should be contained in the key, not the value. For example, rather than + # `{"instanceLimit": "100/request"}`, should be returned as, + # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of + # instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the + # proximate cause of the error. Error reasons are unique within a particular + # domain of errors. This should be at most 63 characters and match a + # regular expression of `A-Z+[A-Z0-9]`, which represents + # UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. + # + # For example, if a quota check failed with an error indicating the calling + # project hasn't enabled the accessed service, this can contain a URL pointing + # directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user + # which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at + # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + # Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota + # type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type + # or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, + }, + ], + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. + # This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. + }, + ], + }, + "timestamp": "A String", # Output only. [Output Only] Timestamp is shown only if there is an error. The field + # has // RFC3339 // + # text format. + }, + }, + ], "autoscaler": "A String", # Output only. [Output Only] The URL of theAutoscaler # that targets this instance group manager. + "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. [Output Only] The status of bulk instance operation. + # targetSizePolicy.mode is set to BULK. + "inProgress": True or False, # Output only. [Output Only] Informs whether bulk instance operation is in progress. + "lastProgressCheck": { # Output only. [Output Only] Information from the last progress check of bulk instance + # operation. + "error": { # Output only. [Output Only] Errors encountered during bulk instance operation. + "errors": [ # [Output Only] The array of errors encountered while processing this + # operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error + # details. There is a set of defined message types to use for providing + # details.The syntax depends on the error code. For example, + # QuotaExceededInfo will have details when the error code is + # QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. + # + # Example of an error when contacting the "pubsub.googleapis.com" API when it + # is not enabled: + # + # { "reason": "API_DISABLED" + # "domain": "googleapis.com" + # "metadata": { + # "resource": "projects/123", + # "service": "pubsub.googleapis.com" + # } + # } + # + # This response indicates that the pubsub.googleapis.com API is not enabled. + # + # Example of an error that is returned when attempting to create a Spanner + # instance in a region that is out of stock: + # + # { "reason": "STOCKOUT" + # "domain": "spanner.googleapis.com", + # "metadata": { + # "availableRegions": "us-central1,us-east2" + # } + # } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain + # is typically the registered service name of the tool or product that + # generates the error. Example: "pubsub.googleapis.com". If the error is + # generated by some common infrastructure, the error domain must be a + # globally unique value that identifies the infrastructure. For Google API + # infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. + # + # Keys must match a regular expression of `a-z+` but should + # ideally be lowerCamelCase. Also, they must be limited to 64 characters in + # length. When identifying the current value of an exceeded limit, the units + # should be contained in the key, not the value. For example, rather than + # `{"instanceLimit": "100/request"}`, should be returned as, + # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of + # instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the + # proximate cause of the error. Error reasons are unique within a particular + # domain of errors. This should be at most 63 characters and match a + # regular expression of `A-Z+[A-Z0-9]`, which represents + # UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. + # + # For example, if a quota check failed with an error indicating the calling + # project hasn't enabled the accessed service, this can contain a URL pointing + # directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user + # which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at + # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + # Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota + # type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type + # or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, + }, + ], + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. + # This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. + }, + ], + }, + "timestamp": "A String", # Output only. [Output Only] Timestamp of the last progress check of bulk instance + # operation. Timestamp is in RFC3339 text format. + }, + }, "isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a # stable state. A stable state means that: none of the instances in the # managed instance group is currently undergoing any type of change (for @@ -3666,6 +4426,11 @@

Method Details

# You can reduce this number by using the instanceGroupManager # deleteInstances or abandonInstances methods. Resizing the group also # changes this number. + "targetSizePolicy": { # The policy that specifies how the MIG creates its VMs to achieve the target + # size. + "mode": "A String", # The mode of target size policy based on which the MIG creates its VMs + # individually or all at once. + }, "targetStoppedSize": 42, # The target number of stopped instances for this managed instance group. # This number changes when you: # @@ -4772,6 +5537,11 @@

Method Details

# on resize events (depending on the value set inupdatePolicy.instanceRedistributionType). "zones": [ # Zones where the regional managed instance group will create and manage # its instances. + # By default, a regional MIG doesn't automatically select an AI zone to create + # instances, even if an AI zone is available in the specified region. To + # create instances in an AI zone in the selected region, you must explicitly + # specify it in the distribution policy together with the other preferred + # zones. { "zone": "A String", # The URL of thezone. # The zone must exist in the region where the managed instance group is @@ -4928,8 +5698,225 @@

Method Details

"effective": True or False, # Output only. [Output Only] A bit indicating whether this configuration has # been applied to all managed instances in the group. }, + "appliedAcceleratorTopologies": [ # Output only. [Output Only] The accelerator topology applied to this MIG. + # Currently only one accelerator topology is supported. + { + "acceleratorTopology": "A String", # Output only. [Output Only] Topology in the format of: "16x16", "4x4x4", etc. + # The value is the same as configured in the WorkloadPolicy. + "state": "A String", # Output only. [Output Only] The state of the accelerator topology. + "stateDetails": { # Output only. [Output Only] The result of the latest accelerator topology state + # check. + "error": { # Output only. [Output Only] Encountered errors. + "errors": [ # [Output Only] The array of errors encountered while processing this + # operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error + # details. There is a set of defined message types to use for providing + # details.The syntax depends on the error code. For example, + # QuotaExceededInfo will have details when the error code is + # QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. + # + # Example of an error when contacting the "pubsub.googleapis.com" API when it + # is not enabled: + # + # { "reason": "API_DISABLED" + # "domain": "googleapis.com" + # "metadata": { + # "resource": "projects/123", + # "service": "pubsub.googleapis.com" + # } + # } + # + # This response indicates that the pubsub.googleapis.com API is not enabled. + # + # Example of an error that is returned when attempting to create a Spanner + # instance in a region that is out of stock: + # + # { "reason": "STOCKOUT" + # "domain": "spanner.googleapis.com", + # "metadata": { + # "availableRegions": "us-central1,us-east2" + # } + # } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain + # is typically the registered service name of the tool or product that + # generates the error. Example: "pubsub.googleapis.com". If the error is + # generated by some common infrastructure, the error domain must be a + # globally unique value that identifies the infrastructure. For Google API + # infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. + # + # Keys must match a regular expression of `a-z+` but should + # ideally be lowerCamelCase. Also, they must be limited to 64 characters in + # length. When identifying the current value of an exceeded limit, the units + # should be contained in the key, not the value. For example, rather than + # `{"instanceLimit": "100/request"}`, should be returned as, + # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of + # instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the + # proximate cause of the error. Error reasons are unique within a particular + # domain of errors. This should be at most 63 characters and match a + # regular expression of `A-Z+[A-Z0-9]`, which represents + # UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. + # + # For example, if a quota check failed with an error indicating the calling + # project hasn't enabled the accessed service, this can contain a URL pointing + # directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user + # which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at + # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + # Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota + # type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type + # or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, + }, + ], + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. + # This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. + }, + ], + }, + "timestamp": "A String", # Output only. [Output Only] Timestamp is shown only if there is an error. The field + # has // RFC3339 // + # text format. + }, + }, + ], "autoscaler": "A String", # Output only. [Output Only] The URL of theAutoscaler # that targets this instance group manager. + "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. [Output Only] The status of bulk instance operation. + # targetSizePolicy.mode is set to BULK. + "inProgress": True or False, # Output only. [Output Only] Informs whether bulk instance operation is in progress. + "lastProgressCheck": { # Output only. [Output Only] Information from the last progress check of bulk instance + # operation. + "error": { # Output only. [Output Only] Errors encountered during bulk instance operation. + "errors": [ # [Output Only] The array of errors encountered while processing this + # operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error + # details. There is a set of defined message types to use for providing + # details.The syntax depends on the error code. For example, + # QuotaExceededInfo will have details when the error code is + # QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. + # + # Example of an error when contacting the "pubsub.googleapis.com" API when it + # is not enabled: + # + # { "reason": "API_DISABLED" + # "domain": "googleapis.com" + # "metadata": { + # "resource": "projects/123", + # "service": "pubsub.googleapis.com" + # } + # } + # + # This response indicates that the pubsub.googleapis.com API is not enabled. + # + # Example of an error that is returned when attempting to create a Spanner + # instance in a region that is out of stock: + # + # { "reason": "STOCKOUT" + # "domain": "spanner.googleapis.com", + # "metadata": { + # "availableRegions": "us-central1,us-east2" + # } + # } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain + # is typically the registered service name of the tool or product that + # generates the error. Example: "pubsub.googleapis.com". If the error is + # generated by some common infrastructure, the error domain must be a + # globally unique value that identifies the infrastructure. For Google API + # infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. + # + # Keys must match a regular expression of `a-z+` but should + # ideally be lowerCamelCase. Also, they must be limited to 64 characters in + # length. When identifying the current value of an exceeded limit, the units + # should be contained in the key, not the value. For example, rather than + # `{"instanceLimit": "100/request"}`, should be returned as, + # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of + # instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the + # proximate cause of the error. Error reasons are unique within a particular + # domain of errors. This should be at most 63 characters and match a + # regular expression of `A-Z+[A-Z0-9]`, which represents + # UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. + # + # For example, if a quota check failed with an error indicating the calling + # project hasn't enabled the accessed service, this can contain a URL pointing + # directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user + # which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at + # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + # Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota + # type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type + # or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, + }, + ], + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. + # This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. + }, + ], + }, + "timestamp": "A String", # Output only. [Output Only] Timestamp of the last progress check of bulk instance + # operation. Timestamp is in RFC3339 text format. + }, + }, "isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a # stable state. A stable state means that: none of the instances in the # managed instance group is currently undergoing any type of change (for @@ -4965,6 +5952,11 @@

Method Details

# You can reduce this number by using the instanceGroupManager # deleteInstances or abandonInstances methods. Resizing the group also # changes this number. + "targetSizePolicy": { # The policy that specifies how the MIG creates its VMs to achieve the target + # size. + "mode": "A String", # The mode of target size policy based on which the MIG creates its VMs + # individually or all at once. + }, "targetStoppedSize": 42, # The target number of stopped instances for this managed instance group. # This number changes when you: # @@ -5290,6 +6282,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5649,6 +6653,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5952,6 +6968,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6247,6 +7275,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6553,6 +7593,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6843,6 +7895,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -7138,6 +8202,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -7444,6 +8520,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -7761,6 +8849,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -8078,6 +9178,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -8437,6 +9549,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.regionInstanceGroups.html b/docs/dyn/compute_v1.regionInstanceGroups.html index 96d83ca902..ebee8e4c17 100644 --- a/docs/dyn/compute_v1.regionInstanceGroups.html +++ b/docs/dyn/compute_v1.regionInstanceGroups.html @@ -752,6 +752,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.regionInstanceTemplates.html b/docs/dyn/compute_v1.regionInstanceTemplates.html index bf988ed429..7fe8b56fb1 100644 --- a/docs/dyn/compute_v1.regionInstanceTemplates.html +++ b/docs/dyn/compute_v1.regionInstanceTemplates.html @@ -261,6 +261,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2440,6 +2452,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.regionInstances.html b/docs/dyn/compute_v1.regionInstances.html index 2e56a65519..be0d9ba8bc 100644 --- a/docs/dyn/compute_v1.regionInstances.html +++ b/docs/dyn/compute_v1.regionInstances.html @@ -1647,6 +1647,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.regionInstantSnapshots.html b/docs/dyn/compute_v1.regionInstantSnapshots.html index 9b1f2eda82..40f3feacb1 100644 --- a/docs/dyn/compute_v1.regionInstantSnapshots.html +++ b/docs/dyn/compute_v1.regionInstantSnapshots.html @@ -279,6 +279,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1124,6 +1136,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2536,6 +2560,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.regionNetworkEndpointGroups.html b/docs/dyn/compute_v1.regionNetworkEndpointGroups.html index 8d4cfbd344..9918a0d876 100644 --- a/docs/dyn/compute_v1.regionNetworkEndpointGroups.html +++ b/docs/dyn/compute_v1.regionNetworkEndpointGroups.html @@ -314,6 +314,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -603,6 +615,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -932,6 +956,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1562,6 +1598,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.regionNetworkFirewallPolicies.html b/docs/dyn/compute_v1.regionNetworkFirewallPolicies.html index b0966f12e0..5c03d451c0 100644 --- a/docs/dyn/compute_v1.regionNetworkFirewallPolicies.html +++ b/docs/dyn/compute_v1.regionNetworkFirewallPolicies.html @@ -309,6 +309,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -766,6 +778,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1048,6 +1072,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1334,6 +1370,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3574,6 +3622,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -4826,6 +4886,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5280,6 +5352,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5562,6 +5646,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5844,6 +5940,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.regionNotificationEndpoints.html b/docs/dyn/compute_v1.regionNotificationEndpoints.html index b784e1402e..8db5bb6f58 100644 --- a/docs/dyn/compute_v1.regionNotificationEndpoints.html +++ b/docs/dyn/compute_v1.regionNotificationEndpoints.html @@ -74,6 +74,12 @@

Compute Engine API . regionNotificationEndpoints

Instance Methods

+

+ aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)

+

Retrieves the list of all NotificationEndpoint resources,

+

+ aggregatedList_next()

+

Retrieves the next page of results.

close()

Close httplib2 connections.

@@ -96,6 +102,257 @@

Instance Methods

testIamPermissions(project, region, resource, body=None, x__xgafv=None)

Returns permissions that a caller has on the specified resource.

Method Details

+
+ aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None) +
Retrieves the list of all NotificationEndpoint resources,
+regional and global, available to the specified project.
+
+Args:
+  project: string, Name of the project scoping this request. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most
+Compute resources support two types of filter expressions:
+expressions that support regular expressions and expressions that follow
+API improvement proposal AIP-160.
+These two types of filter expressions cannot be mixed in one request.
+
+If you want to use AIP-160, your expression must specify the field name, an
+operator, and the value that you want to use for filtering. The value
+must be a string, a number, or a boolean. The operator
+must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
+
+For example, if you are filtering Compute Engine instances, you can
+exclude instances named `example-instance` by specifying
+`name != example-instance`.
+
+The `:*` comparison can be used to test whether a key has been defined.
+For example, to find all objects with `owner` label use:
+```
+labels.owner:*
+```
+
+You can also filter nested fields. For example, you could specify
+`scheduling.automaticRestart = false` to include instances only
+if they are not scheduled for automatic restarts. You can use filtering
+on nested fields to filter based onresource labels.
+
+To filter on multiple expressions, provide each separate expression within
+parentheses. For example:
+```
+(scheduling.automaticRestart = true)
+(cpuPlatform = "Intel Skylake")
+```
+By default, each expression is an `AND` expression. However, you
+can include `AND` and `OR` expressions explicitly.
+For example:
+```
+(cpuPlatform = "Intel Skylake") OR
+(cpuPlatform = "Intel Broadwell") AND
+(scheduling.automaticRestart = true)
+```
+
+If you want to use a regular expression, use the `eq` (equal) or `ne`
+(not equal) operator against a single un-parenthesized expression with or
+without quotes or against multiple parenthesized expressions. Examples:
+
+`fieldname eq unquoted literal`
+`fieldname eq 'single quoted literal'`
+`fieldname eq "double quoted literal"`
+`(fieldname1 eq literal) (fieldname2 ne "literal")`
+
+The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
+The literal value must match the entire field.
+
+For example, to filter for instances that do not end with name "instance",
+you would use `name ne .*instance`.
+
+You cannot combine constraints on multiple fields using regular
+expressions.
+  includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
+global) should be included in the response. For new resource types added
+after this field, the flag has no effect as new resource types will always
+include every visible scope for each scope type in response. For resource
+types which predate this field, if this flag is omitted or false, only
+scopes of the scope types where the resource type is expected to be found
+will be included.
+  maxResults: integer, The maximum number of results per page that should be returned.
+If the number of available results is larger than `maxResults`,
+Compute Engine returns a `nextPageToken` that can be used to get
+the next page of results in subsequent list requests. Acceptable values are
+`0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results
+are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation
+timestamp using `orderBy="creationTimestamp desc"`. This sorts
+results based on the `creationTimestamp` field in
+reverse chronological order (newest result first). Use this to sort
+resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by `name` or
+`creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the
+`nextPageToken` returned by a previous list request to get
+the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
+of failure. The default value is false.
+
+For example, when partial success behavior is enabled, aggregatedList for a
+single zone scope either returns all resources in the zone or no resources,
+with an error code.
+  serviceProjectNumber: string, The Shared VPC service project id or service project number for which
+aggregated list request is invoked for subnetworks list-usable api.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Contains a list of NotificationEndpointsScopedList.
+  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+  "items": { # A list of NotificationEndpointsScopedList resources.
+    "a_key": { # Name of the scope containing this set of NotificationEndpoints.
+      "resources": [ # A list of NotificationEndpoints contained in this scope.
+        { # Represents a notification endpoint.
+            #
+            # A notification endpoint resource defines an endpoint to receive notifications
+            # when there are status changes detected by the associated health check
+            # service.
+            #
+            # For more information, see
+            # Health checks overview.
+          "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+              # text format.
+          "description": "A String", # An optional description of this resource. Provide this property when you
+              # create the resource.
+          "grpcSettings": { # Represents a gRPC setting that describes one gRPC notification endpoint and # Settings of the gRPC notification endpoint including the endpoint URL and
+              # the retry duration.
+              # the retry duration attempting to send notification to this endpoint.
+            "authority": "A String", # Optional. If specified, this field is used to set the authority header by
+                # the sender of notifications. See
+                # https://tools.ietf.org/html/rfc7540#section-8.1.2.3
+            "endpoint": "A String", # Endpoint to which gRPC notifications are sent. This must be a valid
+                # gRPCLB DNS name.
+            "payloadName": "A String", # Optional. If specified, this field is used to populate the "name" field
+                # in gRPC requests.
+            "resendInterval": { # A Duration represents a fixed-length span of time represented # Optional. This field is used to configure how often to send a full update
+                # of all non-healthy backends. If unspecified, full updates are not sent.
+                # If specified, must be in the range between 600 seconds to 3600 seconds.
+                # Nanos are disallowed. Can only be set for regional notification
+                # endpoints.
+                # as a count of seconds and fractions of seconds at nanosecond
+                # resolution. It is independent of any calendar and concepts like "day"
+                # or "month". Range is approximately 10,000 years.
+              "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+                  # Durations less than one second are represented with a 0
+                  # `seconds` field and a positive `nanos` field. Must be from 0
+                  # to 999,999,999 inclusive.
+              "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+                  # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+                  # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+            },
+            "retryDurationSec": 42, # How much time (in seconds) is spent attempting notification retries
+                # until a successful response is received. Default is 30s. Limit is 20m
+                # (1200s). Must be a positive number.
+          },
+          "id": "A String", # Output only. [Output Only] A unique identifier for this resource type. The server
+              # generates this identifier.
+          "kind": "compute#notificationEndpoint", # Output only. [Output Only] Type of the resource. Alwayscompute#notificationEndpoint for notification endpoints.
+          "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+              # The name must be 1-63 characters long, and comply withRFC1035.
+              # Specifically, the name must be 1-63 characters long and match the regular
+              # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
+              # character must be a lowercase letter, and all following characters must
+              # be a dash, lowercase letter, or digit, except the last character, which
+              # cannot be a dash.
+          "region": "A String", # Output only. [Output Only] URL of the region where the notification endpoint resides.
+              # This field applies only to the regional resource. You must specify this
+              # field as part of the HTTP request URL. It is not settable as a field in
+              # the request body.
+          "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
+        },
+      ],
+      "warning": { # Informational warning which replaces the list of
+          # notification endpoints when the list is empty.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+            # Engine returns NO_RESULTS_ON_PAGE if there
+            # are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key:
+            # value format. For example:
+            #
+            # "data": [
+            #   {
+            #    "key": "scope",
+            #    "value": "zones/us-east1-d"
+            #   }
+          {
+            "key": "A String", # [Output Only] A key that provides more detail on the warning being
+                # returned. For example, for warnings where there are no results in a list
+                # request for a particular zone, this key might be scope and
+                # the key value might be the zone name. Other examples might be a key
+                # indicating a deprecated resource and a suggested replacement, or a
+                # warning about invalid network settings (for example, if an instance
+                # attempts to perform IP forwarding but is not enabled for IP forwarding).
+            "value": "A String", # [Output Only] A warning data value corresponding to the key.
+          },
+        ],
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+      },
+    },
+  },
+  "kind": "compute#notificationEndpointAggregatedList", # Output only. Type of resource.
+  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for
+      # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
+      # the query parameter pageToken in the next list request.
+      # Subsequent list requests will have their own nextPageToken to
+      # continue paging through the results.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined URL for this resource.
+  "unreachables": [ # Output only. [Output Only] Unreachable resources.
+    "A String",
+  ],
+  "warning": { # [Output Only] Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+        # Engine returns NO_RESULTS_ON_PAGE if there
+        # are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key:
+        # value format. For example:
+        #
+        # "data": [
+        #   {
+        #    "key": "scope",
+        #    "value": "zones/us-east1-d"
+        #   }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being
+            # returned. For example, for warnings where there are no results in a list
+            # request for a particular zone, this key might be scope and
+            # the key value might be the zone name. Other examples might be a key
+            # indicating a deprecated resource and a suggested replacement, or a
+            # warning about invalid network settings (for example, if an instance
+            # attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ aggregatedList_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.
+        
+
+
close()
Close httplib2 connections.
@@ -263,6 +520,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -682,6 +951,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.regionOperations.html b/docs/dyn/compute_v1.regionOperations.html index a4aaf42b85..ee35161515 100644 --- a/docs/dyn/compute_v1.regionOperations.html +++ b/docs/dyn/compute_v1.regionOperations.html @@ -264,6 +264,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -619,6 +631,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -953,6 +977,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.regionSecurityPolicies.html b/docs/dyn/compute_v1.regionSecurityPolicies.html index 1628102b33..f7f45efe2b 100644 --- a/docs/dyn/compute_v1.regionSecurityPolicies.html +++ b/docs/dyn/compute_v1.regionSecurityPolicies.html @@ -671,6 +671,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -957,6 +969,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2924,6 +2948,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -4603,6 +4639,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5285,6 +5333,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5554,6 +5614,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5852,6 +5924,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.regionSslCertificates.html b/docs/dyn/compute_v1.regionSslCertificates.html index dfe4df8918..25ad3c2049 100644 --- a/docs/dyn/compute_v1.regionSslCertificates.html +++ b/docs/dyn/compute_v1.regionSslCertificates.html @@ -260,6 +260,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -733,6 +745,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.regionSslPolicies.html b/docs/dyn/compute_v1.regionSslPolicies.html index abd2919e3f..4aecc43e80 100644 --- a/docs/dyn/compute_v1.regionSslPolicies.html +++ b/docs/dyn/compute_v1.regionSslPolicies.html @@ -269,6 +269,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -445,8 +457,9 @@

Method Details

# lowercase letter, or digit, except the last character, which cannot be a # dash. "profile": "A String", # Profile specifies the set of SSL features that can be used by the load - # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features - # to enable must be specified in the customFeatures field. + # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED,FIPS_202205, or CUSTOM. If usingCUSTOM, the set of SSL features to enable must be specified in + # the customFeatures field. If using FIPS_202205, + # the min_tls_version field must be set to TLS_1_2. "region": "A String", # Output only. [Output Only] URL of the region where the regional SSL policy # resides. This field is not applicable to global SSL policies. "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. @@ -532,8 +545,9 @@

Method Details

# lowercase letter, or digit, except the last character, which cannot be a # dash. "profile": "A String", # Profile specifies the set of SSL features that can be used by the load - # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features - # to enable must be specified in the customFeatures field. + # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED,FIPS_202205, or CUSTOM. If usingCUSTOM, the set of SSL features to enable must be specified in + # the customFeatures field. If using FIPS_202205, + # the min_tls_version field must be set to TLS_1_2. "region": "A String", # Output only. [Output Only] URL of the region where the regional SSL policy # resides. This field is not applicable to global SSL policies. "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. @@ -721,6 +735,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -982,8 +1008,9 @@

Method Details

# lowercase letter, or digit, except the last character, which cannot be a # dash. "profile": "A String", # Profile specifies the set of SSL features that can be used by the load - # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features - # to enable must be specified in the customFeatures field. + # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED,FIPS_202205, or CUSTOM. If usingCUSTOM, the set of SSL features to enable must be specified in + # the customFeatures field. If using FIPS_202205, + # the min_tls_version field must be set to TLS_1_2. "region": "A String", # Output only. [Output Only] URL of the region where the regional SSL policy # resides. This field is not applicable to global SSL policies. "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. @@ -1224,8 +1251,9 @@

Method Details

# lowercase letter, or digit, except the last character, which cannot be a # dash. "profile": "A String", # Profile specifies the set of SSL features that can be used by the load - # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features - # to enable must be specified in the customFeatures field. + # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED,FIPS_202205, or CUSTOM. If usingCUSTOM, the set of SSL features to enable must be specified in + # the customFeatures field. If using FIPS_202205, + # the min_tls_version field must be set to TLS_1_2. "region": "A String", # Output only. [Output Only] URL of the region where the regional SSL policy # resides. This field is not applicable to global SSL policies. "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. @@ -1413,6 +1441,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.regionTargetHttpProxies.html b/docs/dyn/compute_v1.regionTargetHttpProxies.html index 9865653543..657a912112 100644 --- a/docs/dyn/compute_v1.regionTargetHttpProxies.html +++ b/docs/dyn/compute_v1.regionTargetHttpProxies.html @@ -263,6 +263,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -698,6 +710,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1205,6 +1229,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.regionTargetHttpsProxies.html b/docs/dyn/compute_v1.regionTargetHttpsProxies.html index 3f1cceeb7d..26dd14bf21 100644 --- a/docs/dyn/compute_v1.regionTargetHttpsProxies.html +++ b/docs/dyn/compute_v1.regionTargetHttpsProxies.html @@ -269,6 +269,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -896,6 +908,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1661,6 +1685,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1953,6 +1989,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2241,6 +2289,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.regionTargetTcpProxies.html b/docs/dyn/compute_v1.regionTargetTcpProxies.html index 6a3658b48a..f806bf1b02 100644 --- a/docs/dyn/compute_v1.regionTargetTcpProxies.html +++ b/docs/dyn/compute_v1.regionTargetTcpProxies.html @@ -260,6 +260,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -641,6 +653,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.regionUrlMaps.html b/docs/dyn/compute_v1.regionUrlMaps.html index e26e022ad8..d295a651de 100644 --- a/docs/dyn/compute_v1.regionUrlMaps.html +++ b/docs/dyn/compute_v1.regionUrlMaps.html @@ -258,6 +258,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5956,6 +5968,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -11791,6 +11815,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -14769,6 +14805,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.reservationBlocks.html b/docs/dyn/compute_v1.reservationBlocks.html index 2484963a6b..023cc9e6f5 100644 --- a/docs/dyn/compute_v1.reservationBlocks.html +++ b/docs/dyn/compute_v1.reservationBlocks.html @@ -977,6 +977,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.reservationSlots.html b/docs/dyn/compute_v1.reservationSlots.html index 8304aa8dfc..a341490690 100644 --- a/docs/dyn/compute_v1.reservationSlots.html +++ b/docs/dyn/compute_v1.reservationSlots.html @@ -80,6 +80,9 @@

Instance Methods

get(project, zone, parentName, reservationSlot, x__xgafv=None)

Retrieves information about the specified reservation slot.

+

+ getVersion(project, zone, parentName, reservationSlot, body=None, requestId=None, x__xgafv=None)

+

Allows customers to get SBOM versions of a reservation slot.

list(project, zone, parentName, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Retrieves a list of reservation slots under a single reservation.

@@ -162,6 +165,311 @@

Method Details

}
+
+ getVersion(project, zone, parentName, reservationSlot, body=None, requestId=None, x__xgafv=None) +
Allows customers to get SBOM versions of a reservation slot.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, Name of the zone for this request. Zone name should conform to RFC1035. (required)
+  parentName: string, The name of the parent reservation and parent block. In the format of
+reservations/{reservation_name}/reservationBlocks/{reservation_block_name}/reservationSubBlocks/{reservation_sub_block_name} (required)
+  reservationSlot: string, The name of the reservation slot.
+Name should conform to RFC1035 or be a resource ID. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "sbomSelections": [ # The SBOM selection to return. Duplicate values in the list will be ignored.
+    "A String",
+  ],
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/v1/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+          # name and the value is the version.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+          # component name and the value is the version.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+
list(project, zone, parentName, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Retrieves a list of reservation slots under a single reservation.
@@ -559,6 +867,18 @@ 

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.reservationSubBlocks.html b/docs/dyn/compute_v1.reservationSubBlocks.html index 63672b6ed4..e48f87f715 100644 --- a/docs/dyn/compute_v1.reservationSubBlocks.html +++ b/docs/dyn/compute_v1.reservationSubBlocks.html @@ -83,6 +83,9 @@

Instance Methods

getIamPolicy(project, zone, parentResource, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)

Gets the access control policy for a resource. May be empty if no such

+

+ getVersion(project, zone, parentName, reservationSubBlock, body=None, requestId=None, x__xgafv=None)

+

Allows customers to get SBOM versions of a reservation subBlock.

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.

@@ -583,6 +586,311 @@

Method Details

}
+
+ getVersion(project, zone, parentName, reservationSubBlock, body=None, requestId=None, x__xgafv=None) +
Allows customers to get SBOM versions of a reservation subBlock.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, Name of the zone for this request. Zone name should conform to RFC1035. (required)
+  parentName: string, The name of the parent reservation and parent block. In the format of
+reservations/{reservation_name}/reservationBlocks/{reservation_block_name} (required)
+  reservationSubBlock: string, The name of the reservation subBlock.
+Name should conform to RFC1035 or be a resource ID. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "sbomSelections": [ # The SBOM selection to return.
+    "A String",
+  ],
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/v1/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+          # name and the value is the version.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+          # component name and the value is the version.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+
list(project, zone, parentName, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Retrieves a list of reservation subBlocks under a single reservation.
@@ -980,6 +1288,18 @@ 

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1278,6 +1598,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.reservations.html b/docs/dyn/compute_v1.reservations.html index 7ac235a2dd..b492530c7b 100644 --- a/docs/dyn/compute_v1.reservations.html +++ b/docs/dyn/compute_v1.reservations.html @@ -704,6 +704,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1826,6 +1838,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2494,6 +2518,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2785,6 +2821,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -4206,6 +4254,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.resourcePolicies.html b/docs/dyn/compute_v1.resourcePolicies.html index 1ac5b897b5..7b12344702 100644 --- a/docs/dyn/compute_v1.resourcePolicies.html +++ b/docs/dyn/compute_v1.resourcePolicies.html @@ -351,6 +351,8 @@

Method Details

"workloadPolicy": { # Represents the workload policy. # Resource policy for defining instance placement for MIGs. "acceleratorTopology": "A String", # Specifies the topology required to create a partition for VMs that have # interconnected GPUs. + "acceleratorTopologyMode": "A String", # Specifies the connection mode for the accelerator topology. If not + # specified, the default is AUTO_CONNECT. "maxTopologyDistance": "A String", # Specifies the maximum distance between instances. "type": "A String", # Specifies the intent of the instance placement in the MIG. }, @@ -603,6 +605,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -863,6 +877,8 @@

Method Details

"workloadPolicy": { # Represents the workload policy. # Resource policy for defining instance placement for MIGs. "acceleratorTopology": "A String", # Specifies the topology required to create a partition for VMs that have # interconnected GPUs. + "acceleratorTopologyMode": "A String", # Specifies the connection mode for the accelerator topology. If not + # specified, the default is AUTO_CONNECT. "maxTopologyDistance": "A String", # Specifies the maximum distance between instances. "type": "A String", # Specifies the intent of the instance placement in the MIG. }, @@ -1373,6 +1389,8 @@

Method Details

"workloadPolicy": { # Represents the workload policy. # Resource policy for defining instance placement for MIGs. "acceleratorTopology": "A String", # Specifies the topology required to create a partition for VMs that have # interconnected GPUs. + "acceleratorTopologyMode": "A String", # Specifies the connection mode for the accelerator topology. If not + # specified, the default is AUTO_CONNECT. "maxTopologyDistance": "A String", # Specifies the maximum distance between instances. "type": "A String", # Specifies the intent of the instance placement in the MIG. }, @@ -1532,6 +1550,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1880,6 +1910,8 @@

Method Details

"workloadPolicy": { # Represents the workload policy. # Resource policy for defining instance placement for MIGs. "acceleratorTopology": "A String", # Specifies the topology required to create a partition for VMs that have # interconnected GPUs. + "acceleratorTopologyMode": "A String", # Specifies the connection mode for the accelerator topology. If not + # specified, the default is AUTO_CONNECT. "maxTopologyDistance": "A String", # Specifies the maximum distance between instances. "type": "A String", # Specifies the intent of the instance placement in the MIG. }, @@ -2070,6 +2102,8 @@

Method Details

"workloadPolicy": { # Represents the workload policy. # Resource policy for defining instance placement for MIGs. "acceleratorTopology": "A String", # Specifies the topology required to create a partition for VMs that have # interconnected GPUs. + "acceleratorTopologyMode": "A String", # Specifies the connection mode for the accelerator topology. If not + # specified, the default is AUTO_CONNECT. "maxTopologyDistance": "A String", # Specifies the maximum distance between instances. "type": "A String", # Specifies the intent of the instance placement in the MIG. }, @@ -2230,6 +2264,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.routers.html b/docs/dyn/compute_v1.routers.html index 5ab066b5a4..add8f2df20 100644 --- a/docs/dyn/compute_v1.routers.html +++ b/docs/dyn/compute_v1.routers.html @@ -1015,6 +1015,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1297,6 +1309,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3708,6 +3732,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5635,6 +5671,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6029,6 +6077,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -7869,6 +7929,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -8263,6 +8335,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.routes.html b/docs/dyn/compute_v1.routes.html index 3b296b7c17..b09689f107 100644 --- a/docs/dyn/compute_v1.routes.html +++ b/docs/dyn/compute_v1.routes.html @@ -262,6 +262,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -891,6 +903,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.securityPolicies.html b/docs/dyn/compute_v1.securityPolicies.html index 53af5a3444..75ee240476 100644 --- a/docs/dyn/compute_v1.securityPolicies.html +++ b/docs/dyn/compute_v1.securityPolicies.html @@ -679,6 +679,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1781,6 +1793,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3745,6 +3769,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -5556,6 +5592,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6237,6 +6285,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6505,6 +6565,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -6792,6 +6864,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.serviceAttachments.html b/docs/dyn/compute_v1.serviceAttachments.html index 77998ce1ee..c6518c6fb1 100644 --- a/docs/dyn/compute_v1.serviceAttachments.html +++ b/docs/dyn/compute_v1.serviceAttachments.html @@ -237,6 +237,7 @@

Method Details

{ # [Output Only] A connection connected to this service attachment. "consumerNetwork": "A String", # The url of the consumer network. "endpoint": "A String", # The url of a connected endpoint. + "endpointWithId": "A String", # The url of a connected endpoint with resource id. "natIps": [ # NAT IPs of the connected PSC endpoint and those of other endpoints # propagated from it. "A String", @@ -260,6 +261,7 @@

Method Details

{ "connectionLimit": 42, # The value of the limit to set. For endpoint_url, the limit should be no # more than 1. + "endpointUrl": "A String", # The URL for the PSC endpoint to accept "networkUrl": "A String", # The network URL for the network to set the limit for. "projectIdOrNum": "A String", # The project id or number for the project to set the limit for. }, @@ -598,6 +600,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -745,6 +759,7 @@

Method Details

{ # [Output Only] A connection connected to this service attachment. "consumerNetwork": "A String", # The url of the consumer network. "endpoint": "A String", # The url of a connected endpoint. + "endpointWithId": "A String", # The url of a connected endpoint with resource id. "natIps": [ # NAT IPs of the connected PSC endpoint and those of other endpoints # propagated from it. "A String", @@ -768,6 +783,7 @@

Method Details

{ "connectionLimit": 42, # The value of the limit to set. For endpoint_url, the limit should be no # more than 1. + "endpointUrl": "A String", # The URL for the PSC endpoint to accept "networkUrl": "A String", # The network URL for the network to set the limit for. "projectIdOrNum": "A String", # The project id or number for the project to set the limit for. }, @@ -1251,6 +1267,7 @@

Method Details

{ # [Output Only] A connection connected to this service attachment. "consumerNetwork": "A String", # The url of the consumer network. "endpoint": "A String", # The url of a connected endpoint. + "endpointWithId": "A String", # The url of a connected endpoint with resource id. "natIps": [ # NAT IPs of the connected PSC endpoint and those of other endpoints # propagated from it. "A String", @@ -1274,6 +1291,7 @@

Method Details

{ "connectionLimit": 42, # The value of the limit to set. For endpoint_url, the limit should be no # more than 1. + "endpointUrl": "A String", # The URL for the PSC endpoint to accept "networkUrl": "A String", # The network URL for the network to set the limit for. "projectIdOrNum": "A String", # The project id or number for the project to set the limit for. }, @@ -1519,6 +1537,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1750,6 +1780,7 @@

Method Details

{ # [Output Only] A connection connected to this service attachment. "consumerNetwork": "A String", # The url of the consumer network. "endpoint": "A String", # The url of a connected endpoint. + "endpointWithId": "A String", # The url of a connected endpoint with resource id. "natIps": [ # NAT IPs of the connected PSC endpoint and those of other endpoints # propagated from it. "A String", @@ -1773,6 +1804,7 @@

Method Details

{ "connectionLimit": 42, # The value of the limit to set. For endpoint_url, the limit should be no # more than 1. + "endpointUrl": "A String", # The URL for the PSC endpoint to accept "networkUrl": "A String", # The network URL for the network to set the limit for. "projectIdOrNum": "A String", # The project id or number for the project to set the limit for. }, @@ -1939,6 +1971,7 @@

Method Details

{ # [Output Only] A connection connected to this service attachment. "consumerNetwork": "A String", # The url of the consumer network. "endpoint": "A String", # The url of a connected endpoint. + "endpointWithId": "A String", # The url of a connected endpoint with resource id. "natIps": [ # NAT IPs of the connected PSC endpoint and those of other endpoints # propagated from it. "A String", @@ -1962,6 +1995,7 @@

Method Details

{ "connectionLimit": 42, # The value of the limit to set. For endpoint_url, the limit should be no # more than 1. + "endpointUrl": "A String", # The URL for the PSC endpoint to accept "networkUrl": "A String", # The network URL for the network to set the limit for. "projectIdOrNum": "A String", # The project id or number for the project to set the limit for. }, @@ -2207,6 +2241,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.snapshotSettings.html b/docs/dyn/compute_v1.snapshotSettings.html index 383a6a5686..52de139429 100644 --- a/docs/dyn/compute_v1.snapshotSettings.html +++ b/docs/dyn/compute_v1.snapshotSettings.html @@ -298,6 +298,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.snapshots.html b/docs/dyn/compute_v1.snapshots.html index b7d049228c..910fa1f21c 100644 --- a/docs/dyn/compute_v1.snapshots.html +++ b/docs/dyn/compute_v1.snapshots.html @@ -278,6 +278,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1580,6 +1592,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3206,6 +3230,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.sslCertificates.html b/docs/dyn/compute_v1.sslCertificates.html index 5f440b64ae..452beca96b 100644 --- a/docs/dyn/compute_v1.sslCertificates.html +++ b/docs/dyn/compute_v1.sslCertificates.html @@ -546,6 +546,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1015,6 +1027,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.sslPolicies.html b/docs/dyn/compute_v1.sslPolicies.html index 15a8c34815..3ad20abb91 100644 --- a/docs/dyn/compute_v1.sslPolicies.html +++ b/docs/dyn/compute_v1.sslPolicies.html @@ -261,8 +261,9 @@

Method Details

# lowercase letter, or digit, except the last character, which cannot be a # dash. "profile": "A String", # Profile specifies the set of SSL features that can be used by the load - # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features - # to enable must be specified in the customFeatures field. + # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED,FIPS_202205, or CUSTOM. If usingCUSTOM, the set of SSL features to enable must be specified in + # the customFeatures field. If using FIPS_202205, + # the min_tls_version field must be set to TLS_1_2. "region": "A String", # Output only. [Output Only] URL of the region where the regional SSL policy # resides. This field is not applicable to global SSL policies. "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. @@ -545,6 +546,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -720,8 +733,9 @@

Method Details

# lowercase letter, or digit, except the last character, which cannot be a # dash. "profile": "A String", # Profile specifies the set of SSL features that can be used by the load - # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features - # to enable must be specified in the customFeatures field. + # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED,FIPS_202205, or CUSTOM. If usingCUSTOM, the set of SSL features to enable must be specified in + # the customFeatures field. If using FIPS_202205, + # the min_tls_version field must be set to TLS_1_2. "region": "A String", # Output only. [Output Only] URL of the region where the regional SSL policy # resides. This field is not applicable to global SSL policies. "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. @@ -805,8 +819,9 @@

Method Details

# lowercase letter, or digit, except the last character, which cannot be a # dash. "profile": "A String", # Profile specifies the set of SSL features that can be used by the load - # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features - # to enable must be specified in the customFeatures field. + # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED,FIPS_202205, or CUSTOM. If usingCUSTOM, the set of SSL features to enable must be specified in + # the customFeatures field. If using FIPS_202205, + # the min_tls_version field must be set to TLS_1_2. "region": "A String", # Output only. [Output Only] URL of the region where the regional SSL policy # resides. This field is not applicable to global SSL policies. "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. @@ -994,6 +1009,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1254,8 +1281,9 @@

Method Details

# lowercase letter, or digit, except the last character, which cannot be a # dash. "profile": "A String", # Profile specifies the set of SSL features that can be used by the load - # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features - # to enable must be specified in the customFeatures field. + # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED,FIPS_202205, or CUSTOM. If usingCUSTOM, the set of SSL features to enable must be specified in + # the customFeatures field. If using FIPS_202205, + # the min_tls_version field must be set to TLS_1_2. "region": "A String", # Output only. [Output Only] URL of the region where the regional SSL policy # resides. This field is not applicable to global SSL policies. "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. @@ -1494,8 +1522,9 @@

Method Details

# lowercase letter, or digit, except the last character, which cannot be a # dash. "profile": "A String", # Profile specifies the set of SSL features that can be used by the load - # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features - # to enable must be specified in the customFeatures field. + # balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED,FIPS_202205, or CUSTOM. If usingCUSTOM, the set of SSL features to enable must be specified in + # the customFeatures field. If using FIPS_202205, + # the min_tls_version field must be set to TLS_1_2. "region": "A String", # Output only. [Output Only] URL of the region where the regional SSL policy # resides. This field is not applicable to global SSL policies. "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. @@ -1683,6 +1712,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.storagePools.html b/docs/dyn/compute_v1.storagePools.html index 141de8d510..f60a72f08f 100644 --- a/docs/dyn/compute_v1.storagePools.html +++ b/docs/dyn/compute_v1.storagePools.html @@ -611,6 +611,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1536,6 +1548,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3322,6 +3346,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.subnetworks.html b/docs/dyn/compute_v1.subnetworks.html index dd2abd7dcd..1e29c770e5 100644 --- a/docs/dyn/compute_v1.subnetworks.html +++ b/docs/dyn/compute_v1.subnetworks.html @@ -747,6 +747,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1038,6 +1050,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2224,6 +2248,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3414,6 +3450,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -4578,6 +4626,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.targetGrpcProxies.html b/docs/dyn/compute_v1.targetGrpcProxies.html index f79c88d648..95d30ebb16 100644 --- a/docs/dyn/compute_v1.targetGrpcProxies.html +++ b/docs/dyn/compute_v1.targetGrpcProxies.html @@ -262,6 +262,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -651,6 +663,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1176,6 +1200,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.targetHttpProxies.html b/docs/dyn/compute_v1.targetHttpProxies.html index 5665d2b0d9..d31e27fbd7 100644 --- a/docs/dyn/compute_v1.targetHttpProxies.html +++ b/docs/dyn/compute_v1.targetHttpProxies.html @@ -509,6 +509,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -942,6 +954,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1513,6 +1537,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1800,6 +1836,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.targetHttpsProxies.html b/docs/dyn/compute_v1.targetHttpsProxies.html index 76b6545776..ae5a87e759 100644 --- a/docs/dyn/compute_v1.targetHttpsProxies.html +++ b/docs/dyn/compute_v1.targetHttpsProxies.html @@ -642,6 +642,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1267,6 +1279,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2030,6 +2054,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2320,6 +2356,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2608,6 +2656,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2901,6 +2961,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3193,6 +3265,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3481,6 +3565,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.targetInstances.html b/docs/dyn/compute_v1.targetInstances.html index 671a6a2919..ad3198671b 100644 --- a/docs/dyn/compute_v1.targetInstances.html +++ b/docs/dyn/compute_v1.targetInstances.html @@ -509,6 +509,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -896,6 +908,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1381,6 +1405,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.targetPools.html b/docs/dyn/compute_v1.targetPools.html index 56c88490c7..0bc2be21ff 100644 --- a/docs/dyn/compute_v1.targetPools.html +++ b/docs/dyn/compute_v1.targetPools.html @@ -301,6 +301,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -599,6 +611,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1154,6 +1178,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1655,6 +1691,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2183,6 +2231,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2476,6 +2536,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2765,6 +2837,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -3056,6 +3140,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.targetSslProxies.html b/docs/dyn/compute_v1.targetSslProxies.html index 6f30fcbd43..ad5b8c0feb 100644 --- a/docs/dyn/compute_v1.targetSslProxies.html +++ b/docs/dyn/compute_v1.targetSslProxies.html @@ -277,6 +277,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -662,6 +674,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1143,6 +1167,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1433,6 +1469,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1721,6 +1769,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2013,6 +2073,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -2305,6 +2377,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.targetTcpProxies.html b/docs/dyn/compute_v1.targetTcpProxies.html index f6309121a6..19f213af82 100644 --- a/docs/dyn/compute_v1.targetTcpProxies.html +++ b/docs/dyn/compute_v1.targetTcpProxies.html @@ -510,6 +510,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -889,6 +901,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1367,6 +1391,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1655,6 +1691,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.targetVpnGateways.html b/docs/dyn/compute_v1.targetVpnGateways.html index 0f66364617..b900f21b94 100644 --- a/docs/dyn/compute_v1.targetVpnGateways.html +++ b/docs/dyn/compute_v1.targetVpnGateways.html @@ -534,6 +534,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -977,6 +989,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1496,6 +1520,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.urlMaps.html b/docs/dyn/compute_v1.urlMaps.html index e1197f69de..ec1bb04587 100644 --- a/docs/dyn/compute_v1.urlMaps.html +++ b/docs/dyn/compute_v1.urlMaps.html @@ -3179,6 +3179,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -8886,6 +8898,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -9193,6 +9217,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -15037,6 +15073,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -18058,6 +18106,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.vpnGateways.html b/docs/dyn/compute_v1.vpnGateways.html index 0f10203370..10acc08887 100644 --- a/docs/dyn/compute_v1.vpnGateways.html +++ b/docs/dyn/compute_v1.vpnGateways.html @@ -560,6 +560,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1092,6 +1104,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1631,6 +1655,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.vpnTunnels.html b/docs/dyn/compute_v1.vpnTunnels.html index 5e53dc40f9..f5f22bc0d1 100644 --- a/docs/dyn/compute_v1.vpnTunnels.html +++ b/docs/dyn/compute_v1.vpnTunnels.html @@ -629,6 +629,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1260,6 +1272,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1874,6 +1898,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.wireGroups.html b/docs/dyn/compute_v1.wireGroups.html index 5c4951dbe5..2614898dae 100644 --- a/docs/dyn/compute_v1.wireGroups.html +++ b/docs/dyn/compute_v1.wireGroups.html @@ -264,6 +264,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -851,6 +863,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -1580,6 +1604,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/docs/dyn/compute_v1.zoneOperations.html b/docs/dyn/compute_v1.zoneOperations.html index dd2aeea752..df838d4b27 100644 --- a/docs/dyn/compute_v1.zoneOperations.html +++ b/docs/dyn/compute_v1.zoneOperations.html @@ -264,6 +264,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -619,6 +631,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error @@ -952,6 +976,18 @@

Method Details

}, ], }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component + # name and the value is the version. + "a_key": "A String", + }, + "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the + # component name and the value is the version. + "a_key": "A String", + }, + }, + }, "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error # message that was returned, such as `NOT FOUND`. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error diff --git a/googleapiclient/discovery_cache/documents/compute.alpha.json b/googleapiclient/discovery_cache/documents/compute.alpha.json index 1961d61a1d..8eadb400b8 100644 --- a/googleapiclient/discovery_cache/documents/compute.alpha.json +++ b/googleapiclient/discovery_cache/documents/compute.alpha.json @@ -4108,6 +4108,9 @@ } }, "path": "projects/{project}/zones/{zone}/disks/{disk}/updateKmsKey", +"request": { +"$ref": "DiskUpdateKmsKeyRequest" +}, "response": { "$ref": "Operation" }, @@ -30228,6 +30231,9 @@ } }, "path": "projects/{project}/regions/{region}/disks/{disk}/updateKmsKey", +"request": { +"$ref": "RegionDiskUpdateKmsKeyRequest" +}, "response": { "$ref": "Operation" }, @@ -38866,6 +38872,9 @@ } }, "path": "projects/{project}/regions/{region}/snapshots/{snapshot}/updateKmsKey", +"request": { +"$ref": "RegionSnapshotUpdateKmsKeyRequest" +}, "response": { "$ref": "Operation" }, @@ -46704,6 +46713,9 @@ } }, "path": "projects/{project}/global/snapshots/{snapshot}/updateKmsKey", +"request": { +"$ref": "SnapshotUpdateKmsKeyRequest" +}, "response": { "$ref": "Operation" }, @@ -54664,7 +54676,7 @@ } } }, -"revision": "20260213", +"revision": "20260227", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -59484,7 +59496,7 @@ false "id": "BackendServiceFailoverPolicy", "properties": { "disableConnectionDrainOnFailover": { -"description": "This can be set to true only if the protocol isTCP.\n\nThe default is false.", +"description": "This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.\n\nThe default is false.", "type": "boolean" }, "dropTrafficIfUnhealthy": { @@ -61560,6 +61572,10 @@ false "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, +"params": { +"$ref": "CommitmentParams", +"description": "Input only. Additional params passed with the request, but not persisted\nas part of resource payload." +}, "plan": { "description": "The minimum time duration that you commit to purchasing resources.\nThe plan that you choose determines the preset term length of the\ncommitment (which is 1 year or 3 years) and affects the discount rate that\nyou receive for your resources. Committing to a longer time duration\ntypically gives you a higher discount rate. The supported values for this\nfield are TWELVE_MONTH (1 year), andTHIRTY_SIX_MONTH (3 years).", "enum": [ @@ -62066,6 +62082,20 @@ false }, "type": "object" }, +"CommitmentParams": { +"description": "Additional commitment params.", +"id": "CommitmentParams", +"properties": { +"resourceManagerTags": { +"additionalProperties": { +"type": "string" +}, +"description": "Input only. Resource manager tags to be bound to the commitment. Tag keys and\nvalues have the same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in\nnamespaced format such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.", +"type": "object" +} +}, +"type": "object" +}, "CommitmentResourceStatus": { "description": "[Output Only] Contains output only fields.", "id": "CommitmentResourceStatus", @@ -64900,6 +64930,16 @@ false }, "type": "object" }, +"DiskUpdateKmsKeyRequest": { +"id": "DiskUpdateKmsKeyRequest", +"properties": { +"kmsKeyName": { +"description": "Optional. The new KMS key to replace the current one on the disk. If empty, the disk\nwill be re-encrypted using the primary version of the disk's current KMS\nkey.\n\nThe KMS key can be provided in the following formats:\n \n \n - projects/project_id/locations/location/keyRings/key_ring/cryptoKeys/key\n\n\nWhere project is the project ID or\nproject number.", +"type": "string" +} +}, +"type": "object" +}, "DisksAddResourcePoliciesRequest": { "id": "DisksAddResourcePoliciesRequest", "properties": { @@ -65135,7 +65175,7 @@ false "type": "string" }, "zones": { -"description": "Zones where the regional managed instance group will create and manage\nits instances.", +"description": "Zones where the regional managed instance group will create and manage\nits instances.\nBy default, a regional MIG doesn't automatically select an AI zone to create\ninstances, even if an AI zone is available in the specified region. To\ncreate instances in an AI zone in the selected region, you must explicitly\nspecify it in the distribution policy together with the other preferred\nzones.", "items": { "$ref": "DistributionPolicyZoneConfiguration" }, @@ -67983,6 +68023,10 @@ false "description": "Name prefix for the reservations to be created at the time of\ndelivery. The name prefix must comply with RFC1035.\nMaximum allowed length for name prefix is 20. Automatically created\nreservations name format will be -date-####.", "type": "string" }, +"params": { +"$ref": "FutureReservationParams", +"description": "Input only. Additional params passed with the request, but not persisted\nas part of resource payload." +}, "planningStatus": { "description": "Planning state before being submitted for evaluation", "enum": [ @@ -68122,6 +68166,20 @@ false }, "type": "object" }, +"FutureReservationParams": { +"description": "Additional future reservation params.", +"id": "FutureReservationParams", +"properties": { +"resourceManagerTags": { +"additionalProperties": { +"type": "string" +}, +"description": "Input only. Resource manager tags to be bound to the future reservation. Tag keys and\nvalues have the same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in\nnamespaced format such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.", +"type": "object" +} +}, +"type": "object" +}, "FutureReservationSpecificSKUProperties": { "id": "FutureReservationSpecificSKUProperties", "properties": { @@ -69804,7 +69862,7 @@ false "id": "GlobalVmExtensionPolicyRolloutOperationRolloutInput", "properties": { "conflictBehavior": { -"description": "Optional. Specifies the behavior of the rollout if a conflict is detected in a\nproject during a rollout. This only applies to `insert` and `update`\nmethods.\n\nA conflict occurs in the following cases:\n* `insert` method: If the zonal policy already exists when the insert\n happens.\n* `update` method: If the zonal policy was modified by a zonal API call\n outside of this rollout.\n\nPossible values are the following:\n* `\"\"` (empty string): If a conflict occurs, the local value is not\n overwritten. This is the default behavior.\n* `\"overwrite\"`: If a conflict occurs, the local value is overwritten\n with the rollout value.", +"description": "Optional. Specifies the behavior of the rollout if a conflict is detected in a\nproject during a rollout. This only applies to `insert` and `update`\nmethods.\n\nA conflict occurs in the following cases:\n\n* `insert` method: If the zonal policy already exists when the insert\n happens.\n* `update` method: If the zonal policy was modified by a zonal API call\n outside of this rollout.\n\nPossible values are the following:\n\n* `\"\"` (empty string): If a conflict occurs, the local value is not\n overwritten. This is the default behavior.\n* `\"overwrite\"`: If a conflict occurs, the local value is overwritten\n with the rollout value.", "type": "string" }, "name": { @@ -69812,7 +69870,7 @@ false "type": "string" }, "predefinedRolloutPlan": { -"description": "Optional. Predefined rollout plan.", +"description": "Optional. Specifies the predefined rollout plan for the policy. Valid values\nare `SLOW_ROLLOUT` and `FAST_ROLLOUT`. The recommended value is\n`SLOW_ROLLOUT` for progressive rollout. For more information, see Rollout\nplans for global policies.", "enum": [ "FAST_ROLLOUT", "ROLLOUT_PLAN_UNSPECIFIED", @@ -69854,6 +69912,14 @@ false "GlobalVmExtensionPolicyRolloutOperationRolloutStatusRolloutMetadata": { "id": "GlobalVmExtensionPolicyRolloutOperationRolloutStatusRolloutMetadata", "properties": { +"locationRolloutStatus": { +"additionalProperties": { +"$ref": "GlobalVmExtensionPolicyRolloutOperationRolloutStatusRolloutMetadataLocationRolloutStatus" +}, +"description": "Output only. [Output Only] The rollout status for each location. The list of the\nlocations is the same as the list of locations in the rollout plan.", +"readOnly": true, +"type": "object" +}, "rollout": { "description": "Output only. [Output Only] The name of the rollout.\nEx. projects//locations/global/rollouts/.", "readOnly": true, @@ -69890,6 +69956,31 @@ false }, "type": "object" }, +"GlobalVmExtensionPolicyRolloutOperationRolloutStatusRolloutMetadataLocationRolloutStatus": { +"id": "GlobalVmExtensionPolicyRolloutOperationRolloutStatusRolloutMetadataLocationRolloutStatus", +"properties": { +"state": { +"description": "Output only. [Output Only] The state of the location rollout.", +"enum": [ +"LOCATION_ROLLOUT_STATE_COMPLETED", +"LOCATION_ROLLOUT_STATE_FAILED", +"LOCATION_ROLLOUT_STATE_NOT_STARTED", +"LOCATION_ROLLOUT_STATE_SKIPPED", +"LOCATION_ROLLOUT_STATE_UNSPECIFIED" +], +"enumDescriptions": [ +"The location rollout is completed.", +"The location rollout has failed.", +"The location rollout has not started.", +"The location rollout is skipped.", +"Default value. This value is unused." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GroupMaintenanceInfo": { "description": "Maintenance Info for ReservationBlocks.", "id": "GroupMaintenanceInfo", @@ -74228,6 +74319,10 @@ false "$ref": "HttpFaultInjection", "description": "The specification for fault injection introduced into traffic to test\nthe resiliency of clients to backend service failure. As part of fault\ninjection, when clients send requests to a backend service, delays can be\nintroduced by a load balancer on a percentage of requests before sending\nthose requests to the backend service. Similarly requests from clients can\nbe aborted by the load balancer for a percentage of requests.timeout and retry_policy is ignored by clients\nthat are configured with a fault_injection_policy if:\n1. The traffic is generated by fault injection AND\n2. The fault injection is not a delay fault injection.\nFault injection is not supported with the classic Application Load Balancer\n. To see which load balancers support fault injection,\nsee Load\nbalancing: Routing and traffic management features." }, +"imageOptimizationPolicy": { +"$ref": "ImageOptimizationPolicy", +"description": "Image optimization policy for this URL Map\u2019s route. Available only for\nGlobal EXTERNAL_MANAGED load balancer schemes.\nEither Cloud CDN must be enabled on the backend service or backend bucket\nserving the route, or cache policy must be configured on the same route" +}, "maxStreamDuration": { "$ref": "Duration", "description": "Specifies the maximum duration (timeout) for streams on the selected route.\nUnlike the timeout field where the timeout duration starts\nfrom the time the request has been fully processed (known as*end-of-stream*),\nthe duration in this field is computed from the beginning of the stream\nuntil the response has been processed, including all retries. A\nstream that does not complete in this duration is closed.\n\nIf not specified, this field uses the maximummaxStreamDuration value among all backend services associated\nwith the route.\n\nThis field is only allowed if the Url map is used with backend services\nwith loadBalancingScheme set toINTERNAL_SELF_MANAGED." @@ -75010,6 +75105,27 @@ false }, "type": "object" }, +"ImageOptimizationPolicy": { +"description": "The configuration for Cloud CDN's image optimization feature. This feature\ndynamically processes and delivers images from the network edge.\nImage Optimization is only available for Global External Application Load\nBalancers.\nEither Cloud CDN must be enabled on the backend service or backend bucket\nserving the route, or cache policy must be configured on the same route.", +"id": "ImageOptimizationPolicy", +"properties": { +"queryParameterInterpretation": { +"description": "Specifies whether to interpret query parameters for image optimization.", +"enum": [ +"DISABLED", +"ENABLED", +"QUERY_PARAMETER_INTERPRETATION_UNSPECIFIED" +], +"enumDescriptions": [ +"Query parameters for image optimization are ignored.", +"Query parameters for image optimization are interpreted.", +"Default value. This field value translates to the\ndefault behavior, which is to ignore query parameters for image\noptimization." +], +"type": "string" +} +}, +"type": "object" +}, "ImageParams": { "description": "Additional image params.", "id": "ImageParams", @@ -91891,6 +92007,13 @@ false }, "type": "array" }, +"aliasIpv6Ranges": { +"description": "An array of alias IPv6 ranges for this network interface.\nYou can only specify this field for network interfaces in VPC networks.", +"items": { +"$ref": "AliasIpRange" +}, +"type": "array" +}, "enableVpcScopedDns": { "description": "Optional. If true, DNS resolution will be enabled over this interface. Only valid\nwith network_attachment.", "type": "boolean" @@ -103036,6 +103159,16 @@ false }, "type": "object" }, +"RegionDiskUpdateKmsKeyRequest": { +"id": "RegionDiskUpdateKmsKeyRequest", +"properties": { +"kmsKeyName": { +"description": "Optional. The new KMS key to replace the current one on the disk. If empty, the disk\nwill be re-encrypted using the primary version of the disk's current KMS\nkey.\n\nThe KMS key can be provided in the following formats:\n \n \n - projects/project_id/locations/location/keyRings/key_ring/cryptoKeys/key\n\n\nWhere project is the project ID or\nproject number.", +"type": "string" +} +}, +"type": "object" +}, "RegionDisksAddResourcePoliciesRequest": { "id": "RegionDisksAddResourcePoliciesRequest", "properties": { @@ -104567,6 +104700,16 @@ false }, "type": "object" }, +"RegionSnapshotUpdateKmsKeyRequest": { +"id": "RegionSnapshotUpdateKmsKeyRequest", +"properties": { +"kmsKeyName": { +"description": "Optional. The new KMS key to replace the current one on the snapshot. If empty, the\nsnapshot will be re-encrypted using the primary version of the snapshot's\ncurrent KMS key.\n\nThe KMS key can be provided in the following formats:\n \n \n - projects/project_id/locations/region/keyRings/region/cryptoKeys/key", +"type": "string" +} +}, +"type": "object" +}, "RegionTargetHttpsProxiesSetSslCertificatesRequest": { "id": "RegionTargetHttpsProxiesSetSslCertificatesRequest", "properties": { @@ -108872,6 +109015,11 @@ false "readOnly": true, "type": "string" }, +"estimatedCompletionTime": { +"description": "Output only. Estimated timestamp at which the wave will complete. Extrapolated from\ncurrent progress.", +"readOnly": true, +"type": "string" +}, "estimatedTotalResourcesCount": { "description": "Output only. Estimated total count of resources.", "format": "int64", @@ -108891,6 +109039,42 @@ false "format": "int64", "readOnly": true, "type": "string" +}, +"locationStatus": { +"additionalProperties": { +"$ref": "RolloutWaveDetailsOrchestratedWaveDetailsLocationStatus" +}, +"description": "Output only. Status of each location in the wave. Map keys (locations) must be\nspecified like \"us-east1\" or \"asia-west1-a\".", +"readOnly": true, +"type": "object" +} +}, +"type": "object" +}, +"RolloutWaveDetailsOrchestratedWaveDetailsLocationStatus": { +"description": "Represents the status of a location in a wave.", +"id": "RolloutWaveDetailsOrchestratedWaveDetailsLocationStatus", +"properties": { +"state": { +"description": "Output only. Location state of the wave.", +"enum": [ +"STATE_FAILED", +"STATE_IN_PROGRESS", +"STATE_PENDING", +"STATE_SKIPPED", +"STATE_SUCCEEDED", +"STATE_UNSPECIFIED" +], +"enumDescriptions": [ +"Location state is FAILED.", +"Location state is PROCESSING.", +"Location state is either INITIALIZED or WAITING.", +"Location state is either CANCELED or SKIPPED.", +"Location state is COMPLETED.", +"Undefined default state. Should never be exposed to users." +], +"readOnly": true, +"type": "string" } }, "type": "object" @@ -113031,7 +113215,7 @@ false "type": "string" }, "ddosImpactedBaselineThreshold": { -"description": "DDoS Protection for Network Load Balancers (and VMs with public IPs)\nbuilds DDos mitigations that minimize collateral damage. It quantifies\nthis as the fraction of a non-abuse baseline that's inadvertently\nblocked.\n\nRules whose collateral damage exceeds ddosImpactedBaselineThreshold will\nnot be deployed. Using a lower value will prioritize keeping collateral\ndamage low, possibly at the cost of its effectiveness in rate limiting\nsome or all of the attack. It should typically be unset, so Advanced DDos\n(and Adaptive Protection) uses the best mitigation it can find. Setting\nthe threshold is advised if there are logs for false positive detections\nwith high collateral damage, and will cause Advanced DDos to attempt to\nfind a less aggressive rule that satisfies the constraint; Failing that,\nit will fall back to no mitigation (smaller attack) or to broader network\nthrottles (larger attack).", +"description": "DDoS Protection for Network Load Balancers (and VMs with public IPs)\nbuilds DDoS mitigations that minimize collateral damage. It quantifies\nthis as the fraction of a non-abuse baseline that's inadvertently\nblocked.\n\nRules whose collateral damage exceeds ddosImpactedBaselineThreshold will\nnot be deployed. Using a lower value will prioritize keeping collateral\ndamage low, possibly at the cost of its effectiveness in rate limiting\nsome or all of the attack. It should typically be unset, so Advanced DDoS\n(and Adaptive Protection) uses the best mitigation it can find. Setting\nthe threshold is advised if there are logs for false positive detections\nwith high collateral damage, and will cause Advanced DDoS to attempt to\nfind a less aggressive rule that satisfies the constraint. If a suitable\nrule cannot be found, the system falls back to either no mitigation for\nsmaller attacks or broader network throttles for larger ones.", "format": "float", "type": "number" }, @@ -115964,6 +116148,16 @@ false }, "type": "object" }, +"SnapshotUpdateKmsKeyRequest": { +"id": "SnapshotUpdateKmsKeyRequest", +"properties": { +"kmsKeyName": { +"description": "Optional. The new KMS key to replace the current one on the snapshot. If empty, the\nsnapshot will be re-encrypted using the primary version of the snapshot's\ncurrent KMS key.\n\nThe KMS key can be provided in the following formats:\n \n \n - projects/project_id/locations/region/keyRings/key_ring/cryptoKeys/key", +"type": "string" +} +}, +"type": "object" +}, "SnapshotsGetEffectiveRecycleBinRuleResponse": { "id": "SnapshotsGetEffectiveRecycleBinRuleResponse", "properties": { @@ -117408,7 +117602,7 @@ false "type": "string" }, "postQuantumKeyExchange": { -"description": "One of DEFAULT, ENABLED, orDEFERRED. Controls whether the load balancer allows\nnegotiating X25519MLKEM768 key exchange when clients advertise support for\nit. When set to DEFAULT, or if no SSL Policy is\nattached to the target proxy, the load balancer disallows X25519MLKEM768\nkey exchange until it is enabled by default on LBs. When set toENABLED, the load balancer will negotiate X25519MLKEM768 key\nexchange. Customers can set this to DEFERRED to temporarily\nopt-out the LB from negotiating post-quantum key exchange by default.", +"description": "One of DEFAULT, ENABLED, orDEFERRED. Controls whether the load balancer allows\nnegotiating X25519MLKEM768 key exchange when clients advertise support for\nit. When set to DEFAULT, or if no SSL Policy is\nattached to the target proxy, the load balancer disallows X25519MLKEM768\nkey exchange until it is enabled by default on load balancers. When set toENABLED, the load balancer can negotiate X25519MLKEM768 key\nexchange. When set to DEFERRED, temporarily opts out the load\nbalancer from negotiating X25519MLKEM768 beyond the point where it is\nenabled by default on load balancers.", "enum": [ "DEFAULT", "DEFERRED", @@ -117422,7 +117616,7 @@ false "type": "string" }, "profile": { -"description": "Profile specifies the set of SSL features that can be used by the load\nbalancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features\nto enable must be specified in the customFeatures field.", +"description": "Profile specifies the set of SSL features that can be used by the load\nbalancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED,FIPS_202205, or CUSTOM. If usingCUSTOM, the set of SSL features to enable must be specified in\nthe customFeatures field. If using FIPS_202205,\nthe min_tls_version field must be set to TLS_1_2.", "enum": [ "COMPATIBLE", "CUSTOM", @@ -119421,6 +119615,24 @@ false "readOnly": true, "type": "string" }, +"ipv6NetworkTier": { +"description": "Specifies the network tier for EXTERNAL IPv6. Can only be set when\nipv6_access_type is EXTERNAL. Defaults to project defaultNetworkTier if not\nspecified during the creation of the subnetwork. This field is IMMUTABLE\nonce set with EXTERNAL IPv6.", +"enum": [ +"FIXED_STANDARD", +"PREMIUM", +"SELECT", +"STANDARD", +"STANDARD_OVERRIDES_FIXED_STANDARD" +], +"enumDescriptions": [ +"Public internet quality with fixed bandwidth.", +"High quality, Google-grade network tier, support for all networking\nproducts.", +"Price competitive network tier, support for all networking products.", +"Public internet quality, only limited support for other networking\nproducts.", +"(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier\nis expired or not configured." +], +"type": "string" +}, "kind": { "default": "compute#subnetwork", "description": "Output only. [Output Only] Type of the resource. Always compute#subnetwork\nfor Subnetwork resources.", @@ -124650,6 +124862,21 @@ false "description": "The latest time for the planned maintenance window to start.\nThis timestamp value is in RFC3339 text format.", "type": "string" }, +"maintenanceMethod": { +"description": "Output only. Maintenance method for the upcoming maintenance.", +"enum": [ +"LIVE_UPDATE", +"MAINTENANCE_METHOD_UNSPECIFIED", +"TERMINATION" +], +"enumDescriptions": [ +"VM will stay alive during maintenance", +"Maintenance method does not specify whether VM will be terminated or not", +"VM will be terminated during maintenance" +], +"readOnly": true, +"type": "string" +}, "maintenanceOnShutdown": { "description": "Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.", "type": "boolean" diff --git a/googleapiclient/discovery_cache/documents/compute.beta.json b/googleapiclient/discovery_cache/documents/compute.beta.json index efe62ce1ec..aefd558cbd 100644 --- a/googleapiclient/discovery_cache/documents/compute.beta.json +++ b/googleapiclient/discovery_cache/documents/compute.beta.json @@ -14591,6 +14591,11 @@ "instance" ], "parameters": { +"discardLocalSsd": { +"description": "Whether to discard local SSDs from the instance during restart\ndefault value is false.", +"location": "query", +"type": "boolean" +}, "instance": { "description": "Name of the instance resource to update.", "location": "path", @@ -28415,6 +28420,72 @@ }, "regionHealthCheckServices": { "methods": { +"aggregatedList": { +"description": "Retrieves the list of all HealthCheckService resources,\nregional and global, available to the specified project.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", +"flatPath": "projects/{project}/aggregated/healthCheckServices", +"httpMethod": "GET", +"id": "compute.regionHealthCheckServices.aggregatedList", +"parameterOrder": [ +"project" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.", +"location": "query", +"type": "string" +}, +"includeAllScopes": { +"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.", +"location": "query", +"type": "boolean" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.", +"location": "query", +"type": "string" +}, +"project": { +"description": "Name of the project scoping 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" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", +"location": "query", +"type": "boolean" +}, +"serviceProjectNumber": { +"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/aggregated/healthCheckServices", +"response": { +"$ref": "HealthCheckServiceAggregatedList" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, "delete": { "description": "Deletes the specified regional HealthCheckService.", "flatPath": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}", @@ -34636,6 +34707,72 @@ }, "regionNotificationEndpoints": { "methods": { +"aggregatedList": { +"description": "Retrieves the list of all NotificationEndpoint resources,\nregional and global, available to the specified project.", +"flatPath": "projects/{project}/aggregated/notificationEndpoints", +"httpMethod": "GET", +"id": "compute.regionNotificationEndpoints.aggregatedList", +"parameterOrder": [ +"project" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.", +"location": "query", +"type": "string" +}, +"includeAllScopes": { +"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.", +"location": "query", +"type": "boolean" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.", +"location": "query", +"type": "string" +}, +"project": { +"description": "Name of the project scoping 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" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", +"location": "query", +"type": "boolean" +}, +"serviceProjectNumber": { +"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/aggregated/notificationEndpoints", +"response": { +"$ref": "NotificationEndpointAggregatedList" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, "delete": { "description": "Deletes the specified NotificationEndpoint in the given region", "flatPath": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}", @@ -38604,6 +38741,61 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, +"getVersion": { +"description": "Allows customers to get SBOM versions of a reservation slot.", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlocksId}/reservationSlots/{reservationSlot}/getVersion", +"httpMethod": "POST", +"id": "compute.reservationSlots.getVersion", +"parameterOrder": [ +"project", +"zone", +"parentName", +"reservationSlot" +], +"parameters": { +"parentName": { +"description": "The name of the parent reservation and parent block. In the format of\nreservations/{reservation_name}/reservationBlocks/{reservation_block_name}/reservationSubBlocks/{reservation_sub_block_name}", +"location": "path", +"pattern": "reservations/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationSubBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"reservationSlot": { +"description": "The name of the reservation slot.\nName should conform to RFC1035 or be a resource ID.", +"location": "path", +"required": true, +"type": "string" +}, +"zone": { +"description": "Name of the zone for this request. Zone name should conform to RFC1035.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/{+parentName}/reservationSlots/{reservationSlot}/getVersion", +"request": { +"$ref": "ReservationSlotsGetVersionRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, "list": { "description": "Retrieves a list of reservation slots under a single reservation.", "flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlocksId}/reservationSlots", @@ -38853,6 +39045,61 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, +"getVersion": { +"description": "Allows customers to get SBOM versions of a reservation subBlock.", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlock}/getVersion", +"httpMethod": "POST", +"id": "compute.reservationSubBlocks.getVersion", +"parameterOrder": [ +"project", +"zone", +"parentName", +"reservationSubBlock" +], +"parameters": { +"parentName": { +"description": "The name of the parent reservation and parent block. In the format of\nreservations/{reservation_name}/reservationBlocks/{reservation_block_name}", +"location": "path", +"pattern": "^reservations/[^/]+/reservationBlocks/[^/]+$", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"reservationSubBlock": { +"description": "The name of the reservation subBlock.\nName should conform to RFC1035 or be a resource ID.", +"location": "path", +"required": true, +"type": "string" +}, +"zone": { +"description": "Name of the zone for this request. Zone name should conform to RFC1035.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/{+parentName}/reservationSubBlocks/{reservationSubBlock}/getVersion", +"request": { +"$ref": "ReservationSubBlocksGetVersionRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, "list": { "description": "Retrieves a list of reservation subBlocks under a single reservation.", "flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks", @@ -51050,7 +51297,7 @@ } } }, -"revision": "20260213", +"revision": "20260227", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -55622,6 +55869,10 @@ false "description": "Defines a dynamic forwarding configuration for the backend service.", "id": "BackendServiceDynamicForwarding", "properties": { +"forwardProxy": { +"$ref": "BackendServiceDynamicForwardingForwardProxy", +"description": "Dynamic Forwarding Proxy configuration." +}, "ipPortSelection": { "$ref": "BackendServiceDynamicForwardingIpPortSelection", "description": "IP:PORT based dynamic forwarding configuration." @@ -55629,6 +55880,29 @@ false }, "type": "object" }, +"BackendServiceDynamicForwardingForwardProxy": { +"description": "Defines Dynamic Forwarding Proxy configuration.", +"id": "BackendServiceDynamicForwardingForwardProxy", +"properties": { +"enabled": { +"description": "A boolean flag enabling dynamic forwarding proxy.", +"type": "boolean" +}, +"proxyMode": { +"description": "Determines the dynamic forwarding proxy mode.", +"enum": [ +"CLOUD_RUN", +"DIRECT_FORWARDING" +], +"enumDescriptions": [ +"Dynamic forwarding directly to Cloud Run services.", +"Dynamic forwarding based on the Http Host header." +], +"type": "string" +} +}, +"type": "object" +}, "BackendServiceDynamicForwardingIpPortSelection": { "description": "Defines a IP:PORT based dynamic forwarding configuration for the backend\nservice. Some ranges are restricted: Restricted\nranges.", "id": "BackendServiceDynamicForwardingIpPortSelection", @@ -55645,7 +55919,7 @@ false "id": "BackendServiceFailoverPolicy", "properties": { "disableConnectionDrainOnFailover": { -"description": "This can be set to true only if the protocol isTCP.\n\nThe default is false.", +"description": "This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.\n\nThe default is false.", "type": "boolean" }, "dropTrafficIfUnhealthy": { @@ -60575,7 +60849,7 @@ false "type": "string" }, "zones": { -"description": "Zones where the regional managed instance group will create and manage\nits instances.", +"description": "Zones where the regional managed instance group will create and manage\nits instances.\nBy default, a regional MIG doesn't automatically select an AI zone to create\ninstances, even if an AI zone is available in the specified region. To\ncreate instances in an AI zone in the selected region, you must explicitly\nspecify it in the distribution policy together with the other preferred\nzones.", "items": { "$ref": "DistributionPolicyZoneConfiguration" }, @@ -64376,6 +64650,35 @@ false }, "type": "object" }, +"GetVersionOperationMetadata": { +"id": "GetVersionOperationMetadata", +"properties": { +"inlineSbomInfo": { +"$ref": "GetVersionOperationMetadataSbomInfo" +} +}, +"type": "object" +}, +"GetVersionOperationMetadataSbomInfo": { +"id": "GetVersionOperationMetadataSbomInfo", +"properties": { +"currentComponentVersions": { +"additionalProperties": { +"type": "string" +}, +"description": "SBOM versions currently applied to the resource. The key is the component\nname and the value is the version.", +"type": "object" +}, +"targetComponentVersions": { +"additionalProperties": { +"type": "string" +}, +"description": "SBOM versions scheduled for the next maintenance. The key is the\ncomponent name and the value is the version.", +"type": "object" +} +}, +"type": "object" +}, "GlobalAddressesMoveRequest": { "id": "GlobalAddressesMoveRequest", "properties": { @@ -64790,7 +65093,7 @@ false "id": "GlobalVmExtensionPolicyRolloutOperationRolloutInput", "properties": { "conflictBehavior": { -"description": "Optional. Specifies the behavior of the rollout if a conflict is detected in a\nproject during a rollout. This only applies to `insert` and `update`\nmethods.\n\nA conflict occurs in the following cases:\n* `insert` method: If the zonal policy already exists when the insert\n happens.\n* `update` method: If the zonal policy was modified by a zonal API call\n outside of this rollout.\n\nPossible values are the following:\n* `\"\"` (empty string): If a conflict occurs, the local value is not\n overwritten. This is the default behavior.\n* `\"overwrite\"`: If a conflict occurs, the local value is overwritten\n with the rollout value.", +"description": "Optional. Specifies the behavior of the rollout if a conflict is detected in a\nproject during a rollout. This only applies to `insert` and `update`\nmethods.\n\nA conflict occurs in the following cases:\n\n* `insert` method: If the zonal policy already exists when the insert\n happens.\n* `update` method: If the zonal policy was modified by a zonal API call\n outside of this rollout.\n\nPossible values are the following:\n\n* `\"\"` (empty string): If a conflict occurs, the local value is not\n overwritten. This is the default behavior.\n* `\"overwrite\"`: If a conflict occurs, the local value is overwritten\n with the rollout value.", "type": "string" }, "name": { @@ -64798,7 +65101,7 @@ false "type": "string" }, "predefinedRolloutPlan": { -"description": "Optional. Predefined rollout plan.", +"description": "Optional. Specifies the predefined rollout plan for the policy. Valid values\nare `SLOW_ROLLOUT` and `FAST_ROLLOUT`. The recommended value is\n`SLOW_ROLLOUT` for progressive rollout. For more information, see Rollout\nplans for global policies.", "enum": [ "FAST_ROLLOUT", "ROLLOUT_PLAN_UNSPECIFIED", @@ -64840,6 +65143,14 @@ false "GlobalVmExtensionPolicyRolloutOperationRolloutStatusRolloutMetadata": { "id": "GlobalVmExtensionPolicyRolloutOperationRolloutStatusRolloutMetadata", "properties": { +"locationRolloutStatus": { +"additionalProperties": { +"$ref": "GlobalVmExtensionPolicyRolloutOperationRolloutStatusRolloutMetadataLocationRolloutStatus" +}, +"description": "Output only. [Output Only] The rollout status for each location. The list of the\nlocations is the same as the list of locations in the rollout plan.", +"readOnly": true, +"type": "object" +}, "rollout": { "description": "Output only. [Output Only] The name of the rollout.\nEx. projects//locations/global/rollouts/.", "readOnly": true, @@ -64876,6 +65187,31 @@ false }, "type": "object" }, +"GlobalVmExtensionPolicyRolloutOperationRolloutStatusRolloutMetadataLocationRolloutStatus": { +"id": "GlobalVmExtensionPolicyRolloutOperationRolloutStatusRolloutMetadataLocationRolloutStatus", +"properties": { +"state": { +"description": "Output only. [Output Only] The state of the location rollout.", +"enum": [ +"LOCATION_ROLLOUT_STATE_COMPLETED", +"LOCATION_ROLLOUT_STATE_FAILED", +"LOCATION_ROLLOUT_STATE_NOT_STARTED", +"LOCATION_ROLLOUT_STATE_SKIPPED", +"LOCATION_ROLLOUT_STATE_UNSPECIFIED" +], +"enumDescriptions": [ +"The location rollout is completed.", +"The location rollout has failed.", +"The location rollout has not started.", +"The location rollout is skipped.", +"Default value. This value is unused." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GroupMaintenanceInfo": { "description": "Maintenance Info for ReservationBlocks.", "id": "GroupMaintenanceInfo", @@ -66125,6 +66461,172 @@ false }, "type": "object" }, +"HealthCheckServiceAggregatedList": { +"description": "Contains a list of HealthCheckServicesScopedList.", +"id": "HealthCheckServiceAggregatedList", +"properties": { +"id": { +"description": "[Output Only] Unique identifier for the resource; defined by the server.", +"type": "string" +}, +"items": { +"additionalProperties": { +"$ref": "HealthCheckServicesScopedList", +"description": "Name of the scope containing this set of HealthCheckServices." +}, +"description": "A list of HealthCheckServicesScopedList resources.", +"type": "object" +}, +"kind": { +"default": "compute#healthCheckServiceAggregatedList", +"description": "Output only. Type of resource.", +"readOnly": true, +"type": "string" +}, +"nextPageToken": { +"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", +"type": "string" +}, +"selfLink": { +"description": "Output only. [Output Only] Server-defined URL for this resource.", +"readOnly": true, +"type": "string" +}, +"unreachables": { +"description": "Output only. [Output Only] Unreachable resources.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"warning": { +"description": "[Output Only] Informational warning message.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"QUOTA_INFO_UNAVAILABLE", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed\noperation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as\ndeprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as\nexperimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden.\nDeprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the\nnetwork.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite\nthe mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g:\nregions.list).", +"The user attempted to use a resource that requires a TOS they have not\naccepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, "HealthCheckServiceReference": { "description": "A full or valid partial URL to a health check service. For example, the\nfollowing are valid URLs:\n \n - https://www.googleapis.com/compute/beta/projects/project-id/regions/us-west1/healthCheckServices/health-check-service\n - projects/project-id/regions/us-west1/healthCheckServices/health-check-service\n - regions/us-west1/healthCheckServices/health-check-service", "id": "HealthCheckServiceReference", @@ -66294,6 +66796,143 @@ false }, "type": "object" }, +"HealthCheckServicesScopedList": { +"id": "HealthCheckServicesScopedList", +"properties": { +"resources": { +"description": "A list of HealthCheckServices contained in this scope.", +"items": { +"$ref": "HealthCheckService" +}, +"type": "array" +}, +"warning": { +"description": "Informational warning which replaces the list of\nbackend services when the list is empty.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"QUOTA_INFO_UNAVAILABLE", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed\noperation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as\ndeprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as\nexperimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden.\nDeprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the\nnetwork.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite\nthe mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g:\nregions.list).", +"The user attempted to use a resource that requires a TOS they have not\naccepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, "HealthChecksAggregatedList": { "id": "HealthChecksAggregatedList", "properties": { @@ -70830,6 +71469,14 @@ false "description": "Output only. [Output only] Status of all-instances configuration on the group.", "readOnly": true }, +"appliedAcceleratorTopologies": { +"description": "Output only. [Output Only] The accelerator topology applied to this MIG.\nCurrently only one accelerator topology is supported.", +"items": { +"$ref": "InstanceGroupManagerStatusAcceleratorTopology" +}, +"readOnly": true, +"type": "array" +}, "autoscaler": { "description": "Output only. [Output Only] The URL of theAutoscaler\nthat targets this instance group manager.", "readOnly": true, @@ -70863,6 +71510,104 @@ false }, "type": "object" }, +"InstanceGroupManagerStatusAcceleratorTopology": { +"id": "InstanceGroupManagerStatusAcceleratorTopology", +"properties": { +"acceleratorTopology": { +"description": "Output only. [Output Only] Topology in the format of: \"16x16\", \"4x4x4\", etc.\nThe value is the same as configured in the WorkloadPolicy.", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. [Output Only] The state of the accelerator topology.", +"enum": [ +"ACTIVATING", +"ACTIVE", +"DEACTIVATING", +"FAILED", +"INCOMPLETE", +"REACTIVATING" +], +"enumDescriptions": [ +"The accelerator topology is being activated.", +"The accelerator topology is active.", +"The accelerator topology is being deactivated.", +"The accelerator topology failed.", +"The configuration is incomplete and the accelerator topology cannot\nbe activated due to insufficient number of running VMs.", +"The accelerator topology is being reactivated." +], +"readOnly": true, +"type": "string" +}, +"stateDetails": { +"$ref": "InstanceGroupManagerStatusAcceleratorTopologyAcceleratorTopologyStateDetails", +"description": "Output only. [Output Only] The result of the latest accelerator topology state\ncheck.", +"readOnly": true +} +}, +"type": "object" +}, +"InstanceGroupManagerStatusAcceleratorTopologyAcceleratorTopologyStateDetails": { +"id": "InstanceGroupManagerStatusAcceleratorTopologyAcceleratorTopologyStateDetails", +"properties": { +"error": { +"description": "Output only. [Output Only] Encountered errors.", +"properties": { +"errors": { +"description": "[Output Only] The array of errors encountered while processing this\noperation.", +"items": { +"properties": { +"code": { +"description": "[Output Only] The error type identifier for this error.", +"type": "string" +}, +"errorDetails": { +"description": "[Output Only] An optional list of messages that contain the error\ndetails. There is a set of defined message types to use for providing\ndetails.The syntax depends on the error code. For example,\nQuotaExceededInfo will have details when the error code is\nQUOTA_EXCEEDED.", +"items": { +"properties": { +"errorInfo": { +"$ref": "ErrorInfo" +}, +"help": { +"$ref": "Help" +}, +"localizedMessage": { +"$ref": "LocalizedMessage" +}, +"quotaInfo": { +"$ref": "QuotaExceededInfo" +} +}, +"type": "object" +}, +"type": "array" +}, +"location": { +"description": "[Output Only] Indicates the field in the request that caused the error.\nThis property is optional.", +"type": "string" +}, +"message": { +"description": "[Output Only] An optional, human-readable error message.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +} +}, +"readOnly": true, +"type": "object" +}, +"timestamp": { +"description": "Output only. [Output Only] Timestamp is shown only if there is an error. The field\nhas // RFC3339 //\ntext format.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "InstanceGroupManagerStatusAllInstancesConfig": { "id": "InstanceGroupManagerStatusAllInstancesConfig", "properties": { @@ -87797,24 +88542,366 @@ false }, "type": "object" }, -"NodeTypeList": { -"description": "Contains a list of node types.", -"id": "NodeTypeList", +"NodeTypeList": { +"description": "Contains a list of node types.", +"id": "NodeTypeList", +"properties": { +"id": { +"description": "[Output Only] Unique identifier for the resource; defined by the server.", +"type": "string" +}, +"items": { +"description": "A list of NodeType resources.", +"items": { +"$ref": "NodeType" +}, +"type": "array" +}, +"kind": { +"default": "compute#nodeTypeList", +"description": "Output only. [Output Only] Type of resource.Always compute#nodeTypeList for\nlists of node types.", +"readOnly": true, +"type": "string" +}, +"nextPageToken": { +"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", +"type": "string" +}, +"selfLink": { +"description": "Output only. [Output Only] Server-defined URL for this resource.", +"readOnly": true, +"type": "string" +}, +"warning": { +"description": "[Output Only] Informational warning message.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"QUOTA_INFO_UNAVAILABLE", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed\noperation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as\ndeprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as\nexperimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden.\nDeprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the\nnetwork.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite\nthe mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g:\nregions.list).", +"The user attempted to use a resource that requires a TOS they have not\naccepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, +"NodeTypesScopedList": { +"id": "NodeTypesScopedList", +"properties": { +"nodeTypes": { +"description": "[Output Only] A list of node types contained in this scope.", +"items": { +"$ref": "NodeType" +}, +"type": "array" +}, +"warning": { +"description": "[Output Only] An informational warning that appears when the node types\nlist is empty.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"QUOTA_INFO_UNAVAILABLE", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed\noperation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as\ndeprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as\nexperimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden.\nDeprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the\nnetwork.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite\nthe mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g:\nregions.list).", +"The user attempted to use a resource that requires a TOS they have not\naccepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, +"NotificationEndpoint": { +"description": "Represents a notification endpoint.\n\nA notification endpoint resource defines an endpoint to receive notifications\nwhen there are status changes detected by the associated health check\nservice.\n\nFor more information, see\nHealth checks overview.", +"id": "NotificationEndpoint", +"properties": { +"creationTimestamp": { +"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "An optional description of this resource. Provide this property when you\ncreate the resource.", +"type": "string" +}, +"grpcSettings": { +"$ref": "NotificationEndpointGrpcSettings", +"description": "Settings of the gRPC notification endpoint including the endpoint URL and\nthe retry duration." +}, +"id": { +"description": "Output only. [Output Only] A unique identifier for this resource type. The server\ngenerates this identifier.", +"format": "uint64", +"readOnly": true, +"type": "string" +}, +"kind": { +"default": "compute#notificationEndpoint", +"description": "Output only. [Output Only] Type of the resource. Alwayscompute#notificationEndpoint for notification endpoints.", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"type": "string" +}, +"region": { +"description": "Output only. [Output Only] URL of the region where the notification endpoint resides.\nThis field applies only to the regional resource. You must specify this\nfield as part of the HTTP request URL. It is not settable as a field in\nthe request body.", +"readOnly": true, +"type": "string" +}, +"selfLink": { +"description": "Output only. [Output Only] Server-defined URL for the resource.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"NotificationEndpointAggregatedList": { +"description": "Contains a list of NotificationEndpointsScopedList.", +"id": "NotificationEndpointAggregatedList", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { -"description": "A list of NodeType resources.", -"items": { -"$ref": "NodeType" +"additionalProperties": { +"$ref": "NotificationEndpointsScopedList", +"description": "Name of the scope containing this set of NotificationEndpoints." }, -"type": "array" +"description": "A list of NotificationEndpointsScopedList resources.", +"type": "object" }, "kind": { -"default": "compute#nodeTypeList", -"description": "Output only. [Output Only] Type of resource.Always compute#nodeTypeList for\nlists of node types.", +"default": "compute#notificationEndpointAggregatedList", +"description": "Output only. Type of resource.", "readOnly": true, "type": "string" }, @@ -87827,6 +88914,14 @@ false "readOnly": true, "type": "string" }, +"unreachables": { +"description": "Output only. [Output Only] Unreachable resources.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "warning": { "description": "[Output Only] Informational warning message.", "properties": { @@ -87954,18 +89049,64 @@ false }, "type": "object" }, -"NodeTypesScopedList": { -"id": "NodeTypesScopedList", +"NotificationEndpointGrpcSettings": { +"description": "Represents a gRPC setting that describes one gRPC notification endpoint and\nthe retry duration attempting to send notification to this endpoint.", +"id": "NotificationEndpointGrpcSettings", "properties": { -"nodeTypes": { -"description": "[Output Only] A list of node types contained in this scope.", +"authority": { +"description": "Optional. If specified, this field is used to set the authority header by\nthe sender of notifications. See\nhttps://tools.ietf.org/html/rfc7540#section-8.1.2.3", +"type": "string" +}, +"endpoint": { +"description": "Endpoint to which gRPC notifications are sent. This must be a valid\ngRPCLB DNS name.", +"type": "string" +}, +"payloadName": { +"description": "Optional. If specified, this field is used to populate the \"name\" field\nin gRPC requests.", +"type": "string" +}, +"resendInterval": { +"$ref": "Duration", +"description": "Optional. This field is used to configure how often to send a full update\nof all non-healthy backends. If unspecified, full updates are not sent.\nIf specified, must be in the range between 600 seconds to 3600 seconds.\nNanos are disallowed. Can only be set for regional notification\nendpoints." +}, +"retryDurationSec": { +"description": "How much time (in seconds) is spent attempting notification retries\nuntil a successful response is received. Default is 30s. Limit is 20m\n(1200s). Must be a positive number.", +"format": "uint32", +"type": "integer" +} +}, +"type": "object" +}, +"NotificationEndpointList": { +"id": "NotificationEndpointList", +"properties": { +"id": { +"description": "[Output Only] Unique identifier for the resource; defined by the server.", +"type": "string" +}, "items": { -"$ref": "NodeType" +"description": "A list of NotificationEndpoint resources.", +"items": { +"$ref": "NotificationEndpoint" }, "type": "array" }, +"kind": { +"default": "compute#notificationEndpointList", +"description": "Output only. [Output Only] Type of the resource. Alwayscompute#notificationEndpoint for notification endpoints.", +"readOnly": true, +"type": "string" +}, +"nextPageToken": { +"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", +"type": "string" +}, +"selfLink": { +"description": "[Output Only] Server-defined URL for this resource.", +"type": "string" +}, "warning": { -"description": "[Output Only] An informational warning that appears when the node types\nlist is empty.", +"description": "[Output Only] Informational warning message.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", @@ -88091,111 +89232,18 @@ false }, "type": "object" }, -"NotificationEndpoint": { -"description": "Represents a notification endpoint.\n\nA notification endpoint resource defines an endpoint to receive notifications\nwhen there are status changes detected by the associated health check\nservice.\n\nFor more information, see\nHealth checks overview.", -"id": "NotificationEndpoint", +"NotificationEndpointsScopedList": { +"id": "NotificationEndpointsScopedList", "properties": { -"creationTimestamp": { -"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.", -"readOnly": true, -"type": "string" -}, -"description": { -"description": "An optional description of this resource. Provide this property when you\ncreate the resource.", -"type": "string" -}, -"grpcSettings": { -"$ref": "NotificationEndpointGrpcSettings", -"description": "Settings of the gRPC notification endpoint including the endpoint URL and\nthe retry duration." -}, -"id": { -"description": "Output only. [Output Only] A unique identifier for this resource type. The server\ngenerates this identifier.", -"format": "uint64", -"readOnly": true, -"type": "string" -}, -"kind": { -"default": "compute#notificationEndpoint", -"description": "Output only. [Output Only] Type of the resource. Alwayscompute#notificationEndpoint for notification endpoints.", -"readOnly": true, -"type": "string" -}, -"name": { -"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"type": "string" -}, -"region": { -"description": "Output only. [Output Only] URL of the region where the notification endpoint resides.\nThis field applies only to the regional resource. You must specify this\nfield as part of the HTTP request URL. It is not settable as a field in\nthe request body.", -"readOnly": true, -"type": "string" -}, -"selfLink": { -"description": "Output only. [Output Only] Server-defined URL for the resource.", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"NotificationEndpointGrpcSettings": { -"description": "Represents a gRPC setting that describes one gRPC notification endpoint and\nthe retry duration attempting to send notification to this endpoint.", -"id": "NotificationEndpointGrpcSettings", -"properties": { -"authority": { -"description": "Optional. If specified, this field is used to set the authority header by\nthe sender of notifications. See\nhttps://tools.ietf.org/html/rfc7540#section-8.1.2.3", -"type": "string" -}, -"endpoint": { -"description": "Endpoint to which gRPC notifications are sent. This must be a valid\ngRPCLB DNS name.", -"type": "string" -}, -"payloadName": { -"description": "Optional. If specified, this field is used to populate the \"name\" field\nin gRPC requests.", -"type": "string" -}, -"resendInterval": { -"$ref": "Duration", -"description": "Optional. This field is used to configure how often to send a full update\nof all non-healthy backends. If unspecified, full updates are not sent.\nIf specified, must be in the range between 600 seconds to 3600 seconds.\nNanos are disallowed. Can only be set for regional notification\nendpoints." -}, -"retryDurationSec": { -"description": "How much time (in seconds) is spent attempting notification retries\nuntil a successful response is received. Default is 30s. Limit is 20m\n(1200s). Must be a positive number.", -"format": "uint32", -"type": "integer" -} -}, -"type": "object" -}, -"NotificationEndpointList": { -"id": "NotificationEndpointList", -"properties": { -"id": { -"description": "[Output Only] Unique identifier for the resource; defined by the server.", -"type": "string" -}, -"items": { -"description": "A list of NotificationEndpoint resources.", +"resources": { +"description": "A list of NotificationEndpoints contained in this scope.", "items": { "$ref": "NotificationEndpoint" }, "type": "array" }, -"kind": { -"default": "compute#notificationEndpointList", -"description": "Output only. [Output Only] Type of the resource. Alwayscompute#notificationEndpoint for notification endpoints.", -"readOnly": true, -"type": "string" -}, -"nextPageToken": { -"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", -"type": "string" -}, -"selfLink": { -"description": "[Output Only] Server-defined URL for this resource.", -"type": "string" -}, "warning": { -"description": "[Output Only] Informational warning message.", +"description": "Informational warning which replaces the list of\nnotification endpoints when the list is empty.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", @@ -88389,6 +89437,9 @@ false }, "type": "object" }, +"getVersionOperationMetadata": { +"$ref": "GetVersionOperationMetadata" +}, "httpErrorMessage": { "description": "[Output Only] If the operation fails, this field contains the HTTP error\nmessage that was returned, such as `NOT FOUND`.", "type": "string" @@ -95318,6 +96369,29 @@ false }, "type": "object" }, +"ReservationSlotsGetVersionRequest": { +"id": "ReservationSlotsGetVersionRequest", +"properties": { +"sbomSelections": { +"description": "The SBOM selection to return. Duplicate values in the list will be ignored.", +"items": { +"enum": [ +"SBOM_SELECTION_CURRENT", +"SBOM_SELECTION_TARGET", +"SBOM_SELECTION_UNSPECIFIED" +], +"enumDescriptions": [ +"", +"", +"" +], +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "ReservationSlotsListResponse": { "description": "A list of reservation slots within a single reservation.", "id": "ReservationSlotsListResponse", @@ -95640,6 +96714,29 @@ false }, "type": "object" }, +"ReservationSubBlocksGetVersionRequest": { +"id": "ReservationSubBlocksGetVersionRequest", +"properties": { +"sbomSelections": { +"description": "The SBOM selection to return.", +"items": { +"enum": [ +"SBOM_SELECTION_CURRENT", +"SBOM_SELECTION_TARGET", +"SBOM_SELECTION_UNSPECIFIED" +], +"enumDescriptions": [ +"", +"", +"" +], +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "ReservationSubBlocksListResponse": { "description": "A list of reservation subBlocks under a single reservation.", "id": "ReservationSubBlocksListResponse", @@ -101816,7 +102913,7 @@ false "type": "string" }, "ddosImpactedBaselineThreshold": { -"description": "DDoS Protection for Network Load Balancers (and VMs with public IPs)\nbuilds DDos mitigations that minimize collateral damage. It quantifies\nthis as the fraction of a non-abuse baseline that's inadvertently\nblocked.\n\nRules whose collateral damage exceeds ddosImpactedBaselineThreshold will\nnot be deployed. Using a lower value will prioritize keeping collateral\ndamage low, possibly at the cost of its effectiveness in rate limiting\nsome or all of the attack. It should typically be unset, so Advanced DDos\n(and Adaptive Protection) uses the best mitigation it can find. Setting\nthe threshold is advised if there are logs for false positive detections\nwith high collateral damage, and will cause Advanced DDos to attempt to\nfind a less aggressive rule that satisfies the constraint; Failing that,\nit will fall back to no mitigation (smaller attack) or to broader network\nthrottles (larger attack).", +"description": "DDoS Protection for Network Load Balancers (and VMs with public IPs)\nbuilds DDoS mitigations that minimize collateral damage. It quantifies\nthis as the fraction of a non-abuse baseline that's inadvertently\nblocked.\n\nRules whose collateral damage exceeds ddosImpactedBaselineThreshold will\nnot be deployed. Using a lower value will prioritize keeping collateral\ndamage low, possibly at the cost of its effectiveness in rate limiting\nsome or all of the attack. It should typically be unset, so Advanced DDoS\n(and Adaptive Protection) uses the best mitigation it can find. Setting\nthe threshold is advised if there are logs for false positive detections\nwith high collateral damage, and will cause Advanced DDoS to attempt to\nfind a less aggressive rule that satisfies the constraint. If a suitable\nrule cannot be found, the system falls back to either no mitigation for\nsmaller attacks or broader network throttles for larger ones.", "format": "float", "type": "number" }, @@ -105950,7 +107047,7 @@ false "type": "string" }, "profile": { -"description": "Profile specifies the set of SSL features that can be used by the load\nbalancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features\nto enable must be specified in the customFeatures field.", +"description": "Profile specifies the set of SSL features that can be used by the load\nbalancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED,FIPS_202205, or CUSTOM. If usingCUSTOM, the set of SSL features to enable must be specified in\nthe customFeatures field. If using FIPS_202205,\nthe min_tls_version field must be set to TLS_1_2.", "enum": [ "COMPATIBLE", "CUSTOM", diff --git a/googleapiclient/discovery_cache/documents/compute.v1.json b/googleapiclient/discovery_cache/documents/compute.v1.json index 66fa83b9e2..cdce0892a7 100644 --- a/googleapiclient/discovery_cache/documents/compute.v1.json +++ b/googleapiclient/discovery_cache/documents/compute.v1.json @@ -13326,6 +13326,11 @@ "instance" ], "parameters": { +"discardLocalSsd": { +"description": "Whether to discard local SSDs from the instance during restart\ndefault value is false.", +"location": "query", +"type": "boolean" +}, "instance": { "description": "Name of the instance resource to update.", "location": "path", @@ -24238,59 +24243,15 @@ } } }, -"regionDiskTypes": { +"regionCompositeHealthChecks": { "methods": { -"get": { -"description": "Returns the specified regional disk type.", -"flatPath": "projects/{project}/regions/{region}/diskTypes/{diskType}", -"httpMethod": "GET", -"id": "compute.regionDiskTypes.get", -"parameterOrder": [ -"project", -"region", -"diskType" -], -"parameters": { -"diskType": { -"description": "Name of the disk type to return.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", -"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" -}, -"region": { -"description": "The name of the region for this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"required": true, -"type": "string" -} -}, -"path": "projects/{project}/regions/{region}/diskTypes/{diskType}", -"response": { -"$ref": "DiskType" -}, -"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 regional disk types available to the specified project.", -"flatPath": "projects/{project}/regions/{region}/diskTypes", +"aggregatedList": { +"description": "Retrieves the list of all CompositeHealthCheck resources (all\nregional) available to the specified project.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", +"flatPath": "projects/{project}/aggregated/compositeHealthChecks", "httpMethod": "GET", -"id": "compute.regionDiskTypes.list", +"id": "compute.regionCompositeHealthChecks.aggregatedList", "parameterOrder": [ -"project", -"region" +"project" ], "parameters": { "filter": { @@ -24298,6 +24259,11 @@ "location": "query", "type": "string" }, +"includeAllScopes": { +"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.", +"location": "query", +"type": "boolean" +}, "maxResults": { "default": "500", "description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", @@ -24317,52 +24283,47 @@ "type": "string" }, "project": { -"description": "Project ID for this request.", +"description": "Name of the project scoping 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" }, -"region": { -"description": "The name of the region for this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"required": true, -"type": "string" -}, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", "location": "query", "type": "boolean" +}, +"serviceProjectNumber": { +"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.", +"format": "int64", +"location": "query", +"type": "string" } }, -"path": "projects/{project}/regions/{region}/diskTypes", +"path": "projects/{project}/aggregated/compositeHealthChecks", "response": { -"$ref": "RegionDiskTypeList" +"$ref": "CompositeHealthCheckAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ] -} -} }, -"regionDisks": { -"methods": { -"addResourcePolicies": { -"description": "Adds existing resource policies to a regional disk. You can only add one\npolicy which will be applied to this disk for scheduling snapshot\ncreation.", -"flatPath": "projects/{project}/regions/{region}/disks/{disk}/addResourcePolicies", -"httpMethod": "POST", -"id": "compute.regionDisks.addResourcePolicies", +"delete": { +"description": "Deletes the specified CompositeHealthCheck in the given region", +"flatPath": "projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}", +"httpMethod": "DELETE", +"id": "compute.regionCompositeHealthChecks.delete", "parameterOrder": [ "project", "region", -"disk" +"compositeHealthCheck" ], "parameters": { -"disk": { -"description": "The disk name for this request.", +"compositeHealthCheck": { +"description": "Name of the CompositeHealthCheck resource to delete.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -24376,7 +24337,7 @@ "type": "string" }, "region": { -"description": "The name of the region for this request.", +"description": "Name of the region scoping this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, @@ -24388,10 +24349,7 @@ "type": "string" } }, -"path": "projects/{project}/regions/{region}/disks/{disk}/addResourcePolicies", -"request": { -"$ref": "RegionDisksAddResourcePoliciesRequest" -}, +"path": "projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}", "response": { "$ref": "Operation" }, @@ -24400,16 +24358,24 @@ "https://www.googleapis.com/auth/compute" ] }, -"bulkInsert": { -"description": "Bulk create a set of disks.", -"flatPath": "projects/{project}/regions/{region}/disks/bulkInsert", -"httpMethod": "POST", -"id": "compute.regionDisks.bulkInsert", +"get": { +"description": "Returns the specified CompositeHealthCheck resource in the given region.", +"flatPath": "projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}", +"httpMethod": "GET", +"id": "compute.regionCompositeHealthChecks.get", "parameterOrder": [ "project", -"region" +"region", +"compositeHealthCheck" ], "parameters": { +"compositeHealthCheck": { +"description": "Name of the CompositeHealthCheck resource to return.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, "project": { "description": "Project ID for this request.", "location": "path", @@ -24418,48 +24384,33 @@ "type": "string" }, "region": { -"description": "The name of the region for this request.", +"description": "Name of the region scoping this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" -}, -"requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", -"location": "query", -"type": "string" } }, -"path": "projects/{project}/regions/{region}/disks/bulkInsert", -"request": { -"$ref": "BulkInsertDiskResource" -}, +"path": "projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}", "response": { -"$ref": "Operation" +"$ref": "CompositeHealthCheck" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" ] }, -"createSnapshot": { -"description": "Creates a snapshot of a specified persistent disk. For regular snapshot\ncreation, consider using snapshots.insert\ninstead, as that method supports more features, such as creating snapshots\nin a project different from the source disk project.", -"flatPath": "projects/{project}/regions/{region}/disks/{disk}/createSnapshot", +"insert": { +"description": "Create a CompositeHealthCheck in the specified project in the given region\nusing the parameters that are included in the request.", +"flatPath": "projects/{project}/regions/{region}/compositeHealthChecks", "httpMethod": "POST", -"id": "compute.regionDisks.createSnapshot", +"id": "compute.regionCompositeHealthChecks.insert", "parameterOrder": [ "project", -"region", -"disk" +"region" ], "parameters": { -"disk": { -"description": "Name of the regional persistent disk to snapshot.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", -"required": true, -"type": "string" -}, "project": { "description": "Project ID for this request.", "location": "path", @@ -24468,7 +24419,7 @@ "type": "string" }, "region": { -"description": "Name of the region for this request.", +"description": "Name of the region scoping this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, @@ -24480,9 +24431,9 @@ "type": "string" } }, -"path": "projects/{project}/regions/{region}/disks/{disk}/createSnapshot", +"path": "projects/{project}/regions/{region}/compositeHealthChecks", "request": { -"$ref": "Snapshot" +"$ref": "CompositeHealthCheck" }, "response": { "$ref": "Operation" @@ -24492,22 +24443,37 @@ "https://www.googleapis.com/auth/compute" ] }, -"delete": { -"description": "Deletes the specified regional persistent disk. Deleting a regional disk\nremoves all the replicas of its data permanently and is irreversible.\nHowever, deleting a disk does not delete anysnapshots\npreviously made from the disk. You must separatelydelete\nsnapshots.", -"flatPath": "projects/{project}/regions/{region}/disks/{disk}", -"httpMethod": "DELETE", -"id": "compute.regionDisks.delete", +"list": { +"description": "Lists the CompositeHealthChecks for a project in the given region.", +"flatPath": "projects/{project}/regions/{region}/compositeHealthChecks", +"httpMethod": "GET", +"id": "compute.regionCompositeHealthChecks.list", "parameterOrder": [ "project", -"region", -"disk" +"region" ], "parameters": { -"disk": { -"description": "Name of the regional persistent disk to delete.", -"location": "path", -"pattern": "\\S{1,66}", -"required": true, +"filter": { +"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.", +"location": "query", "type": "string" }, "project": { @@ -24518,42 +24484,42 @@ "type": "string" }, "region": { -"description": "Name of the region for this request.", +"description": "Name of the region scoping this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, -"requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", "location": "query", -"type": "string" +"type": "boolean" } }, -"path": "projects/{project}/regions/{region}/disks/{disk}", +"path": "projects/{project}/regions/{region}/compositeHealthChecks", "response": { -"$ref": "Operation" +"$ref": "CompositeHealthCheckList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" ] }, -"get": { -"description": "Returns a specified regional persistent disk.", -"flatPath": "projects/{project}/regions/{region}/disks/{disk}", -"httpMethod": "GET", -"id": "compute.regionDisks.get", +"patch": { +"description": "Updates the specified regional CompositeHealthCheck resource\nwith the data included in the request. This method supportsPATCH\nsemantics and uses theJSON merge\npatch format and processing rules.", +"flatPath": "projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}", +"httpMethod": "PATCH", +"id": "compute.regionCompositeHealthChecks.patch", "parameterOrder": [ "project", "region", -"disk" +"compositeHealthCheck" ], "parameters": { -"disk": { -"description": "Name of the regional persistent disk to return.", +"compositeHealthCheck": { +"description": "Name of the CompositeHealthCheck to update. The name\nmust be 1-63 characters long, and comply with RFC1035.", "location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" }, @@ -24565,40 +24531,41 @@ "type": "string" }, "region": { -"description": "Name of the region for this request.", +"description": "Name of the region scoping this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" } }, -"path": "projects/{project}/regions/{region}/disks/{disk}", +"path": "projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}", +"request": { +"$ref": "CompositeHealthCheck" +}, "response": { -"$ref": "Disk" +"$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] }, -"getIamPolicy": { -"description": "Gets the access control policy for a resource. May be empty if no such\npolicy or resource exists.", -"flatPath": "projects/{project}/regions/{region}/disks/{resource}/getIamPolicy", -"httpMethod": "GET", -"id": "compute.regionDisks.getIamPolicy", +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource.", +"flatPath": "projects/{project}/regions/{region}/compositeHealthChecks/{resource}/testIamPermissions", +"httpMethod": "POST", +"id": "compute.regionCompositeHealthChecks.testIamPermissions", "parameterOrder": [ "project", "region", "resource" ], "parameters": { -"optionsRequestedPolicyVersion": { -"description": "Requested IAM Policy version.", -"format": "int32", -"location": "query", -"type": "integer" -}, "project": { "description": "Project ID for this request.", "location": "path", @@ -24621,26 +24588,41 @@ "type": "string" } }, -"path": "projects/{project}/regions/{region}/disks/{resource}/getIamPolicy", +"path": "projects/{project}/regions/{region}/compositeHealthChecks/{resource}/testIamPermissions", +"request": { +"$ref": "TestPermissionsRequest" +}, "response": { -"$ref": "Policy" +"$ref": "TestPermissionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ] +} +} }, -"insert": { -"description": "Creates a persistent regional disk in the specified project using the data\nincluded in the request.", -"flatPath": "projects/{project}/regions/{region}/disks", -"httpMethod": "POST", -"id": "compute.regionDisks.insert", +"regionDiskTypes": { +"methods": { +"get": { +"description": "Returns the specified regional disk type.", +"flatPath": "projects/{project}/regions/{region}/diskTypes/{diskType}", +"httpMethod": "GET", +"id": "compute.regionDiskTypes.get", "parameterOrder": [ "project", -"region" +"region", +"diskType" ], "parameters": { +"diskType": { +"description": "Name of the disk type to return.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, "project": { "description": "Project ID for this request.", "location": "path", @@ -24649,40 +24631,423 @@ "type": "string" }, "region": { -"description": "Name of the region for this request.", +"description": "The name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" -}, -"requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", -"location": "query", -"type": "string" -}, -"sourceImage": { -"description": "Source image to restore onto a disk. This field is optional.", -"location": "query", -"type": "string" } }, -"path": "projects/{project}/regions/{region}/disks", -"request": { -"$ref": "Disk" -}, +"path": "projects/{project}/regions/{region}/diskTypes/{diskType}", "response": { -"$ref": "Operation" +"$ref": "DiskType" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" ] }, "list": { -"description": "Retrieves the list of persistent disks contained within\nthe specified region.", -"flatPath": "projects/{project}/regions/{region}/disks", +"description": "Retrieves a list of regional disk types available to the specified project.", +"flatPath": "projects/{project}/regions/{region}/diskTypes", "httpMethod": "GET", -"id": "compute.regionDisks.list", +"id": "compute.regionDiskTypes.list", +"parameterOrder": [ +"project", +"region" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.", +"location": "query", +"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" +}, +"region": { +"description": "The name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", +"location": "query", +"type": "boolean" +} +}, +"path": "projects/{project}/regions/{region}/diskTypes", +"response": { +"$ref": "RegionDiskTypeList" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +} +} +}, +"regionDisks": { +"methods": { +"addResourcePolicies": { +"description": "Adds existing resource policies to a regional disk. You can only add one\npolicy which will be applied to this disk for scheduling snapshot\ncreation.", +"flatPath": "projects/{project}/regions/{region}/disks/{disk}/addResourcePolicies", +"httpMethod": "POST", +"id": "compute.regionDisks.addResourcePolicies", +"parameterOrder": [ +"project", +"region", +"disk" +], +"parameters": { +"disk": { +"description": "The disk name 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" +}, +"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" +}, +"region": { +"description": "The name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/disks/{disk}/addResourcePolicies", +"request": { +"$ref": "RegionDisksAddResourcePoliciesRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"bulkInsert": { +"description": "Bulk create a set of disks.", +"flatPath": "projects/{project}/regions/{region}/disks/bulkInsert", +"httpMethod": "POST", +"id": "compute.regionDisks.bulkInsert", +"parameterOrder": [ +"project", +"region" +], +"parameters": { +"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" +}, +"region": { +"description": "The name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/disks/bulkInsert", +"request": { +"$ref": "BulkInsertDiskResource" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"createSnapshot": { +"description": "Creates a snapshot of a specified persistent disk. For regular snapshot\ncreation, consider using snapshots.insert\ninstead, as that method supports more features, such as creating snapshots\nin a project different from the source disk project.", +"flatPath": "projects/{project}/regions/{region}/disks/{disk}/createSnapshot", +"httpMethod": "POST", +"id": "compute.regionDisks.createSnapshot", +"parameterOrder": [ +"project", +"region", +"disk" +], +"parameters": { +"disk": { +"description": "Name of the regional persistent disk to snapshot.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"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" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/disks/{disk}/createSnapshot", +"request": { +"$ref": "Snapshot" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"delete": { +"description": "Deletes the specified regional persistent disk. Deleting a regional disk\nremoves all the replicas of its data permanently and is irreversible.\nHowever, deleting a disk does not delete anysnapshots\npreviously made from the disk. You must separatelydelete\nsnapshots.", +"flatPath": "projects/{project}/regions/{region}/disks/{disk}", +"httpMethod": "DELETE", +"id": "compute.regionDisks.delete", +"parameterOrder": [ +"project", +"region", +"disk" +], +"parameters": { +"disk": { +"description": "Name of the regional persistent disk to delete.", +"location": "path", +"pattern": "\\S{1,66}", +"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" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/disks/{disk}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"get": { +"description": "Returns a specified regional persistent disk.", +"flatPath": "projects/{project}/regions/{region}/disks/{disk}", +"httpMethod": "GET", +"id": "compute.regionDisks.get", +"parameterOrder": [ +"project", +"region", +"disk" +], +"parameters": { +"disk": { +"description": "Name of the regional persistent disk to return.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"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" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/disks/{disk}", +"response": { +"$ref": "Disk" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"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}/regions/{region}/disks/{resource}/getIamPolicy", +"httpMethod": "GET", +"id": "compute.regionDisks.getIamPolicy", +"parameterOrder": [ +"project", +"region", +"resource" +], +"parameters": { +"optionsRequestedPolicyVersion": { +"description": "Requested IAM Policy version.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"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" +}, +"region": { +"description": "The name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-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" +} +}, +"path": "projects/{project}/regions/{region}/disks/{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" +] +}, +"insert": { +"description": "Creates a persistent regional disk in the specified project using the data\nincluded in the request.", +"flatPath": "projects/{project}/regions/{region}/disks", +"httpMethod": "POST", +"id": "compute.regionDisks.insert", +"parameterOrder": [ +"project", +"region" +], +"parameters": { +"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" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"sourceImage": { +"description": "Source image to restore onto a disk. This field is optional.", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/disks", +"request": { +"$ref": "Disk" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"list": { +"description": "Retrieves the list of persistent disks contained within\nthe specified region.", +"flatPath": "projects/{project}/regions/{region}/disks", +"httpMethod": "GET", +"id": "compute.regionDisks.list", "parameterOrder": [ "project", "region" @@ -25546,6 +25911,72 @@ }, "regionHealthCheckServices": { "methods": { +"aggregatedList": { +"description": "Retrieves the list of all HealthCheckService resources,\nregional and global, available to the specified project.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", +"flatPath": "projects/{project}/aggregated/healthCheckServices", +"httpMethod": "GET", +"id": "compute.regionHealthCheckServices.aggregatedList", +"parameterOrder": [ +"project" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.", +"location": "query", +"type": "string" +}, +"includeAllScopes": { +"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.", +"location": "query", +"type": "boolean" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.", +"location": "query", +"type": "string" +}, +"project": { +"description": "Name of the project scoping 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" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", +"location": "query", +"type": "boolean" +}, +"serviceProjectNumber": { +"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/aggregated/healthCheckServices", +"response": { +"$ref": "HealthCheckServiceAggregatedList" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, "delete": { "description": "Deletes the specified regional HealthCheckService.", "flatPath": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}", @@ -26181,22 +26612,89 @@ } } }, -"regionInstanceGroupManagers": { +"regionHealthSources": { "methods": { -"abandonInstances": { -"description": "Flags the specified instances to be immediately removed from the managed\ninstance group. Abandoning an instance does not delete the\ninstance, but it does remove the instance from any target pools that are\napplied by the managed instance group. This method reduces thetargetSize of the managed instance group by the\nnumber of instances that you abandon. This operation is marked asDONE when the action is scheduled even if the instances have\nnot yet been removed from the group. You must separately verify the\nstatus of the abandoning action with thelistmanagedinstances\nmethod.\n\nIf the group is part of a backend\nservice that has enabled\nconnection draining, it can take up to 60 seconds after the connection\ndraining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.", -"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/abandonInstances", -"httpMethod": "POST", -"id": "compute.regionInstanceGroupManagers.abandonInstances", +"aggregatedList": { +"description": "Retrieves the list of all HealthSource resources (all\nregional) available to the specified project.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", +"flatPath": "projects/{project}/aggregated/healthSources", +"httpMethod": "GET", +"id": "compute.regionHealthSources.aggregatedList", +"parameterOrder": [ +"project" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.", +"location": "query", +"type": "string" +}, +"includeAllScopes": { +"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.", +"location": "query", +"type": "boolean" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.", +"location": "query", +"type": "string" +}, +"project": { +"description": "Name of the project scoping 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" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", +"location": "query", +"type": "boolean" +}, +"serviceProjectNumber": { +"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/aggregated/healthSources", +"response": { +"$ref": "HealthSourceAggregatedList" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"delete": { +"description": "Deletes the specified HealthSource in the given region", +"flatPath": "projects/{project}/regions/{region}/healthSources/{healthSource}", +"httpMethod": "DELETE", +"id": "compute.regionHealthSources.delete", "parameterOrder": [ "project", "region", -"instanceGroupManager" +"healthSource" ], "parameters": { -"instanceGroupManager": { -"description": "Name of the managed instance group.", +"healthSource": { +"description": "Name of the HealthSource resource to delete.", "location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" }, @@ -26210,6 +26708,7 @@ "region": { "description": "Name of the region scoping this request.", "location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, @@ -26219,10 +26718,7 @@ "type": "string" } }, -"path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/abandonInstances", -"request": { -"$ref": "RegionInstanceGroupManagersAbandonInstancesRequest" -}, +"path": "projects/{project}/regions/{region}/healthSources/{healthSource}", "response": { "$ref": "Operation" }, @@ -26231,20 +26727,21 @@ "https://www.googleapis.com/auth/compute" ] }, -"applyUpdatesToInstances": { -"description": "Apply updates to selected instances the managed instance group.", -"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances", -"httpMethod": "POST", -"id": "compute.regionInstanceGroupManagers.applyUpdatesToInstances", +"get": { +"description": "Returns the specified HealthSource resource in the given region.", +"flatPath": "projects/{project}/regions/{region}/healthSources/{healthSource}", +"httpMethod": "GET", +"id": "compute.regionHealthSources.get", "parameterOrder": [ "project", "region", -"instanceGroupManager" +"healthSource" ], "parameters": { -"instanceGroupManager": { -"description": "The name of the managed instance group, should conform to RFC1035.", +"healthSource": { +"description": "Name of the HealthSource resource to return.", "location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" }, @@ -26256,41 +26753,33 @@ "type": "string" }, "region": { -"description": "Name of the region scoping this request, should conform to RFC1035.", +"description": "Name of the region scoping this request.", "location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances", -"request": { -"$ref": "RegionInstanceGroupManagersApplyUpdatesRequest" -}, +"path": "projects/{project}/regions/{region}/healthSources/{healthSource}", "response": { -"$ref": "Operation" +"$ref": "HealthSource" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" ] }, -"createInstances": { -"description": "Creates instances with per-instance configurations in this regional managed\ninstance group. Instances are created using the current instance template.\nThe create instances operation is marked DONE if\nthe createInstances request is successful. The underlying\nactions take additional time. You must separately verify the status of thecreating or actions with the listmanagedinstances\nmethod.", -"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/createInstances", +"insert": { +"description": "Create a HealthSource in the specified project in the given region\nusing the parameters that are included in the request.", +"flatPath": "projects/{project}/regions/{region}/healthSources", "httpMethod": "POST", -"id": "compute.regionInstanceGroupManagers.createInstances", +"id": "compute.regionHealthSources.insert", "parameterOrder": [ "project", -"region", -"instanceGroupManager" +"region" ], "parameters": { -"instanceGroupManager": { -"description": "The name of the managed instance group.\nIt should conform to RFC1035.", -"location": "path", -"required": true, -"type": "string" -}, "project": { "description": "Project ID for this request.", "location": "path", @@ -26299,20 +26788,21 @@ "type": "string" }, "region": { -"description": "The name of theregion\nwhere the managed instance group is located.\nIt should conform to RFC1035.", +"description": "Name of the region scoping this request.", "location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, "requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, -"path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/createInstances", +"path": "projects/{project}/regions/{region}/healthSources", "request": { -"$ref": "RegionInstanceGroupManagersCreateInstancesRequest" +"$ref": "HealthSource" }, "response": { "$ref": "Operation" @@ -26322,19 +26812,82 @@ "https://www.googleapis.com/auth/compute" ] }, -"delete": { -"description": "Deletes the specified managed instance group and all of the instances\nin that group.", -"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}", -"httpMethod": "DELETE", -"id": "compute.regionInstanceGroupManagers.delete", +"list": { +"description": "Lists the HealthSources for a project in the given region.", +"flatPath": "projects/{project}/regions/{region}/healthSources", +"httpMethod": "GET", +"id": "compute.regionHealthSources.list", +"parameterOrder": [ +"project", +"region" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.", +"location": "query", +"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" +}, +"region": { +"description": "Name of the region scoping this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", +"location": "query", +"type": "boolean" +} +}, +"path": "projects/{project}/regions/{region}/healthSources", +"response": { +"$ref": "HealthSourceList" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"patch": { +"description": "Updates the specified regional HealthSource resource\nwith the data included in the request. This method supportsPATCH\nsemantics and uses theJSON merge\npatch format and processing rules.", +"flatPath": "projects/{project}/regions/{region}/healthSources/{healthSource}", +"httpMethod": "PATCH", +"id": "compute.regionHealthSources.patch", "parameterOrder": [ "project", "region", -"instanceGroupManager" +"healthSource" ], "parameters": { -"instanceGroupManager": { -"description": "Name of the managed instance group to delete.", +"healthSource": { +"description": "Name of the HealthSource to update. The name\nmust be 1-63 characters long, and comply with RFC1035.", "location": "path", "required": true, "type": "string" @@ -26349,6 +26902,7 @@ "region": { "description": "Name of the region scoping this request.", "location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, @@ -26358,7 +26912,10 @@ "type": "string" } }, -"path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}", +"path": "projects/{project}/regions/{region}/healthSources/{healthSource}", +"request": { +"$ref": "HealthSource" +}, "response": { "$ref": "Operation" }, @@ -26367,11 +26924,245 @@ "https://www.googleapis.com/auth/compute" ] }, -"deleteInstances": { -"description": "Flags the specified instances in the managed instance group to be\nimmediately deleted. The instances are also removed from any target\npools of which they were a member. This method reduces thetargetSize of the managed instance group by the number of\ninstances that you delete.\nThe deleteInstances operation is marked DONE if\nthe deleteInstances request is successful. The underlying\nactions take additional time. You must separately verify the status of thedeleting action with thelistmanagedinstances\nmethod.\n\nIf the group is part of a backend\nservice that has enabled\nconnection draining, it can take up to 60 seconds after the connection\ndraining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.", -"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deleteInstances", +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource.", +"flatPath": "projects/{project}/regions/{region}/healthSources/{resource}/testIamPermissions", "httpMethod": "POST", -"id": "compute.regionInstanceGroupManagers.deleteInstances", +"id": "compute.regionHealthSources.testIamPermissions", +"parameterOrder": [ +"project", +"region", +"resource" +], +"parameters": { +"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" +}, +"region": { +"description": "The name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-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" +} +}, +"path": "projects/{project}/regions/{region}/healthSources/{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" +] +} +} +}, +"regionInstanceGroupManagers": { +"methods": { +"abandonInstances": { +"description": "Flags the specified instances to be immediately removed from the managed\ninstance group. Abandoning an instance does not delete the\ninstance, but it does remove the instance from any target pools that are\napplied by the managed instance group. This method reduces thetargetSize of the managed instance group by the\nnumber of instances that you abandon. This operation is marked asDONE when the action is scheduled even if the instances have\nnot yet been removed from the group. You must separately verify the\nstatus of the abandoning action with thelistmanagedinstances\nmethod.\n\nIf the group is part of a backend\nservice that has enabled\nconnection draining, it can take up to 60 seconds after the connection\ndraining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.", +"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/abandonInstances", +"httpMethod": "POST", +"id": "compute.regionInstanceGroupManagers.abandonInstances", +"parameterOrder": [ +"project", +"region", +"instanceGroupManager" +], +"parameters": { +"instanceGroupManager": { +"description": "Name of the managed instance group.", +"location": "path", +"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" +}, +"region": { +"description": "Name of the region scoping this request.", +"location": "path", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/abandonInstances", +"request": { +"$ref": "RegionInstanceGroupManagersAbandonInstancesRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"applyUpdatesToInstances": { +"description": "Apply updates to selected instances the managed instance group.", +"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances", +"httpMethod": "POST", +"id": "compute.regionInstanceGroupManagers.applyUpdatesToInstances", +"parameterOrder": [ +"project", +"region", +"instanceGroupManager" +], +"parameters": { +"instanceGroupManager": { +"description": "The name of the managed instance group, should conform to RFC1035.", +"location": "path", +"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" +}, +"region": { +"description": "Name of the region scoping this request, should conform to RFC1035.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances", +"request": { +"$ref": "RegionInstanceGroupManagersApplyUpdatesRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"createInstances": { +"description": "Creates instances with per-instance configurations in this regional managed\ninstance group. Instances are created using the current instance template.\nThe create instances operation is marked DONE if\nthe createInstances request is successful. The underlying\nactions take additional time. You must separately verify the status of thecreating or actions with the listmanagedinstances\nmethod.", +"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/createInstances", +"httpMethod": "POST", +"id": "compute.regionInstanceGroupManagers.createInstances", +"parameterOrder": [ +"project", +"region", +"instanceGroupManager" +], +"parameters": { +"instanceGroupManager": { +"description": "The name of the managed instance group.\nIt should conform to RFC1035.", +"location": "path", +"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" +}, +"region": { +"description": "The name of theregion\nwhere the managed instance group is located.\nIt should conform to RFC1035.", +"location": "path", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/createInstances", +"request": { +"$ref": "RegionInstanceGroupManagersCreateInstancesRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"delete": { +"description": "Deletes the specified managed instance group and all of the instances\nin that group.", +"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}", +"httpMethod": "DELETE", +"id": "compute.regionInstanceGroupManagers.delete", +"parameterOrder": [ +"project", +"region", +"instanceGroupManager" +], +"parameters": { +"instanceGroupManager": { +"description": "Name of the managed instance group to delete.", +"location": "path", +"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" +}, +"region": { +"description": "Name of the region scoping this request.", +"location": "path", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"deleteInstances": { +"description": "Flags the specified instances in the managed instance group to be\nimmediately deleted. The instances are also removed from any target\npools of which they were a member. This method reduces thetargetSize of the managed instance group by the number of\ninstances that you delete.\nThe deleteInstances operation is marked DONE if\nthe deleteInstances request is successful. The underlying\nactions take additional time. You must separately verify the status of thedeleting action with thelistmanagedinstances\nmethod.\n\nIf the group is part of a backend\nservice that has enabled\nconnection draining, it can take up to 60 seconds after the connection\ndraining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.", +"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deleteInstances", +"httpMethod": "POST", +"id": "compute.regionInstanceGroupManagers.deleteInstances", "parameterOrder": [ "project", "region", @@ -29470,6 +30261,72 @@ }, "regionNotificationEndpoints": { "methods": { +"aggregatedList": { +"description": "Retrieves the list of all NotificationEndpoint resources,\nregional and global, available to the specified project.", +"flatPath": "projects/{project}/aggregated/notificationEndpoints", +"httpMethod": "GET", +"id": "compute.regionNotificationEndpoints.aggregatedList", +"parameterOrder": [ +"project" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.", +"location": "query", +"type": "string" +}, +"includeAllScopes": { +"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.", +"location": "query", +"type": "boolean" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.", +"location": "query", +"type": "string" +}, +"project": { +"description": "Name of the project scoping 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" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", +"location": "query", +"type": "boolean" +}, +"serviceProjectNumber": { +"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/aggregated/notificationEndpoints", +"response": { +"$ref": "NotificationEndpointAggregatedList" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, "delete": { "description": "Deletes the specified NotificationEndpoint in the given region", "flatPath": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}", @@ -32636,6 +33493,61 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, +"getVersion": { +"description": "Allows customers to get SBOM versions of a reservation slot.", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlocksId}/reservationSlots/{reservationSlot}/getVersion", +"httpMethod": "POST", +"id": "compute.reservationSlots.getVersion", +"parameterOrder": [ +"project", +"zone", +"parentName", +"reservationSlot" +], +"parameters": { +"parentName": { +"description": "The name of the parent reservation and parent block. In the format of\nreservations/{reservation_name}/reservationBlocks/{reservation_block_name}/reservationSubBlocks/{reservation_sub_block_name}", +"location": "path", +"pattern": "reservations/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationSubBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"reservationSlot": { +"description": "The name of the reservation slot.\nName should conform to RFC1035 or be a resource ID.", +"location": "path", +"required": true, +"type": "string" +}, +"zone": { +"description": "Name of the zone for this request. Zone name should conform to RFC1035.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/{+parentName}/reservationSlots/{reservationSlot}/getVersion", +"request": { +"$ref": "ReservationSlotsGetVersionRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, "list": { "description": "Retrieves a list of reservation slots under a single reservation.", "flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlocksId}/reservationSlots", @@ -32885,6 +33797,61 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, +"getVersion": { +"description": "Allows customers to get SBOM versions of a reservation subBlock.", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlock}/getVersion", +"httpMethod": "POST", +"id": "compute.reservationSubBlocks.getVersion", +"parameterOrder": [ +"project", +"zone", +"parentName", +"reservationSubBlock" +], +"parameters": { +"parentName": { +"description": "The name of the parent reservation and parent block. In the format of\nreservations/{reservation_name}/reservationBlocks/{reservation_block_name}", +"location": "path", +"pattern": "^reservations/[^/]+/reservationBlocks/[^/]+$", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"reservationSubBlock": { +"description": "The name of the reservation subBlock.\nName should conform to RFC1035 or be a resource ID.", +"location": "path", +"required": true, +"type": "string" +}, +"zone": { +"description": "Name of the zone for this request. Zone name should conform to RFC1035.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/{+parentName}/reservationSubBlocks/{reservationSubBlock}/getVersion", +"request": { +"$ref": "ReservationSubBlocksGetVersionRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, "list": { "description": "Retrieves a list of reservation subBlocks under a single reservation.", "flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks", @@ -43506,7 +44473,7 @@ } } }, -"revision": "20260213", +"revision": "20260227", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -47511,7 +48478,7 @@ false "id": "BackendServiceFailoverPolicy", "properties": { "disableConnectionDrainOnFailover": { -"description": "This can be set to true only if the protocol isTCP.\n\nThe default is false.", +"description": "This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.\n\nThe default is false.", "type": "boolean" }, "dropTrafficIfUnhealthy": { @@ -49683,198 +50650,253 @@ false }, "type": "object" }, -"ConfidentialInstanceConfig": { -"description": "A set of Confidential Instance options.", -"id": "ConfidentialInstanceConfig", +"CompositeHealthCheck": { +"description": "Represents a composite health check.\n\nA composite health check resource specifies the health source resources and\nthe health destination resource to which the aggregated health result from\nthe health source resources is delivered.", +"id": "CompositeHealthCheck", "properties": { -"confidentialInstanceType": { -"description": "Defines the type of technology used by the confidential instance.", -"enum": [ -"CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED", -"SEV", -"SEV_SNP", -"TDX" -], -"enumDescriptions": [ -"No type specified. Do not use this value.", -"AMD Secure Encrypted Virtualization.", -"AMD Secure Encrypted Virtualization - Secure Nested Paging.", -"Intel Trust Domain eXtension." -], +"creationTimestamp": { +"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.", +"readOnly": true, "type": "string" }, -"enableConfidentialCompute": { -"description": "Defines whether the instance should have confidential compute enabled.", -"type": "boolean" -} +"description": { +"description": "An optional description of this resource. Provide this property when you\ncreate the resource.", +"type": "string" }, -"type": "object" +"fingerprint": { +"description": "Fingerprint of this resource. A hash of the contents stored in this object.\nThis field is used in optimistic locking. This field will be ignored when\ninserting a CompositeHealthCheck. An up-to-date fingerprint\nmust be provided in order to patch the CompositeHealthCheck; Otherwise,\nthe request will fail with error 412 conditionNotMet. To see\nthe latest fingerprint, make a get() request to retrieve the\nCompositeHealthCheck.", +"format": "byte", +"type": "string" }, -"ConnectionDraining": { -"description": "Message containing connection draining configuration.", -"id": "ConnectionDraining", -"properties": { -"drainingTimeoutSec": { -"description": "Configures a duration timeout for existing requests on a removed backend\ninstance. For supported load balancers and protocols, as described inEnabling\nconnection draining.", -"format": "int32", -"type": "integer" -} +"healthDestination": { +"description": "URL to the destination resource. Must be set. Must be aForwardingRule. The ForwardingRule must have\nload balancing scheme INTERNAL orINTERNAL_MANAGED and must be regional and in the same region\nas the CompositeHealthCheck (cross-region deployment forINTERNAL_MANAGED is not supported). Can be mutated.", +"type": "string" }, -"type": "object" +"healthSources": { +"description": "URLs to the HealthSource resources whose results are AND'ed.\nI.e. he aggregated result is is HEALTHY only if all sources\nare HEALTHY. Must have at least 1. Must not have more than 10.\nMust be regional and in the same region as theCompositeHealthCheck. Can be mutated.", +"items": { +"type": "string" }, -"ConsistentHashLoadBalancerSettings": { -"description": "This message defines settings for a consistent hash style load balancer.", -"id": "ConsistentHashLoadBalancerSettings", -"properties": { -"httpCookie": { -"$ref": "ConsistentHashLoadBalancerSettingsHttpCookie", -"description": "Hash is based on HTTP Cookie. This field describes a HTTP cookie that will\nbe used as the hash key for the consistent hash load balancer. If the\ncookie is not present, it will be generated. This field is applicable if\nthe sessionAffinity is set to HTTP_COOKIE.\n\nNot supported when the backend service is referenced by a URL map that is\nbound to target gRPC proxy that has validateForProxyless field set to true." +"type": "array" }, -"httpHeaderName": { -"description": "The hash based on the value of the specified header field. This field is\napplicable if the sessionAffinity is set toHEADER_FIELD.", +"id": { +"description": "Output only. [Output Only] A unique identifier for this resource type. The server\ngenerates this identifier.", +"format": "uint64", +"readOnly": true, "type": "string" }, -"minimumRingSize": { -"description": "The minimum number of virtual nodes to use for the hash ring. Defaults to\n1024. Larger ring sizes result in more granular load distributions. If the\nnumber of hosts in the load balancing pool is larger than the ring size,\neach host will be assigned a single virtual node.", -"format": "int64", +"kind": { +"default": "compute#compositeHealthCheck", +"description": "Output only. [Output Only] Type of the resource. Alwayscompute#compositeHealthCheck for composite health checks.", +"readOnly": true, "type": "string" -} -}, -"type": "object" }, -"ConsistentHashLoadBalancerSettingsHttpCookie": { -"description": "The information about the HTTP Cookie on which the hash function is based\nfor load balancing policies that use a consistent hash.", -"id": "ConsistentHashLoadBalancerSettingsHttpCookie", -"properties": { "name": { -"description": "Name of the cookie.", +"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, -"path": { -"description": "Path to set for the cookie.", +"region": { +"description": "Output only. [Output Only] URL of the region where the composite health check resides.\nThis field applies only to the regional resource. You must specify this\nfield as part of the HTTP request URL. It is not settable as a field in\nthe request body.", +"readOnly": true, "type": "string" }, -"ttl": { -"$ref": "Duration", -"description": "Lifetime of the cookie." +"selfLink": { +"description": "Output only. [Output Only] Server-defined URL for the resource.", +"readOnly": true, +"type": "string" +}, +"selfLinkWithId": { +"description": "Output only. [Output Only] Server-defined URL with id for the resource.", +"readOnly": true, +"type": "string" } }, "type": "object" }, -"CorsPolicy": { -"description": "The specification for allowing client-side cross-origin requests. For more\ninformation about the W3C recommendation for cross-origin resource sharing\n(CORS), see Fetch API Living\nStandard.", -"id": "CorsPolicy", +"CompositeHealthCheckAggregatedList": { +"description": "Contains a list of CompositeHealthChecksScopedList.", +"id": "CompositeHealthCheckAggregatedList", "properties": { -"allowCredentials": { -"description": "In response to a preflight request, setting this to true\nindicates that\nthe actual request can include user credentials. This field translates to\nthe Access-Control-Allow-Credentials header.\n\nDefault is false.", -"type": "boolean" -}, -"allowHeaders": { -"description": "Specifies the content for the Access-Control-Allow-Headers\nheader.", -"items": { +"id": { +"description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, -"type": "array" -}, -"allowMethods": { -"description": "Specifies the content for the Access-Control-Allow-Methods\nheader.", "items": { -"type": "string" +"additionalProperties": { +"$ref": "CompositeHealthChecksScopedList", +"description": "Name of the scope containing this set of CompositeHealthChecks." }, -"type": "array" +"description": "A list of CompositeHealthChecksScopedList resources.", +"type": "object" }, -"allowOriginRegexes": { -"description": "Specifies a regular expression that matches allowed origins. For\nmore information, see regular expression syntax. \n\nAn origin is allowed if it matches either an item inallowOrigins or an item inallowOriginRegexes.\n\nRegular expressions can only be used when the loadBalancingScheme is\nset to INTERNAL_SELF_MANAGED.", -"items": { +"kind": { +"default": "compute#compositeHealthCheckAggregatedList", +"description": "Output only. Type of resource.", +"readOnly": true, "type": "string" }, -"type": "array" -}, -"allowOrigins": { -"description": "Specifies the list of origins that is allowed to do CORS requests.\n\nAn origin is allowed if it matches either an item inallowOrigins or an item inallowOriginRegexes.", -"items": { +"nextPageToken": { +"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", "type": "string" }, -"type": "array" -}, -"disabled": { -"description": "If true, disables the CORS policy.\nThe default value is false, which indicates that the CORS\npolicy is in effect.", -"type": "boolean" +"selfLink": { +"description": "Output only. [Output Only] Server-defined URL for this resource.", +"readOnly": true, +"type": "string" }, -"exposeHeaders": { -"description": "Specifies the content for the Access-Control-Expose-Headers\nheader.", +"unreachables": { +"description": "Output only. [Output Only] Unreachable resources.", "items": { "type": "string" }, +"readOnly": true, "type": "array" }, -"maxAge": { -"description": "Specifies how long results of a preflight request can be cached in\nseconds. This field translates to the Access-Control-Max-Age\nheader.", -"format": "int32", -"type": "integer" -} -}, -"type": "object" -}, -"CrossSiteNetwork": { -"description": "A resource that represents a cross-site network.\n\nYou can use cross-site networks to connect your on-premises networks to\neach other through Interconnect connections.", -"id": "CrossSiteNetwork", +"warning": { +"description": "[Output Only] Informational warning message.", "properties": { -"creationTimestamp": { -"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.", -"readOnly": true, +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"QUOTA_INFO_UNAVAILABLE", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed\noperation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as\ndeprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as\nexperimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden.\nDeprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the\nnetwork.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite\nthe mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g:\nregions.list).", +"The user attempted to use a resource that requires a TOS they have not\naccepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], "type": "string" }, -"description": { -"description": "An optional description of the cross-site network.", +"data": { +"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, -"id": { -"description": "Output only. [Output Only] The unique identifier for the resource type. The server\ngenerates this identifier.", -"format": "uint64", -"readOnly": true, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", "type": "string" +} }, -"kind": { -"default": "compute#crossSiteNetwork", -"description": "Output only. [Output Only] Type of the resource. Alwayscompute#crossSiteNetwork for cross-site networks.", -"readOnly": true, -"type": "string" +"type": "object" }, -"name": { -"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"type": "string" +"type": "array" }, -"selfLink": { -"description": "Output only. [Output Only] Server-defined URL for the resource.", -"readOnly": true, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", "type": "string" } }, "type": "object" +} }, -"CrossSiteNetworkList": { -"description": "Response to the list request that contains a list of cross-site networks.", -"id": "CrossSiteNetworkList", -"properties": { -"etag": { -"type": "string" +"type": "object" }, +"CompositeHealthCheckList": { +"id": "CompositeHealthCheckList", +"properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { -"description": "A list of CrossSiteNetwork resources.", +"description": "A list of CompositeHealthCheck resources.", "items": { -"$ref": "CrossSiteNetwork" +"$ref": "CompositeHealthCheck" }, "type": "array" }, "kind": { -"default": "compute#crossSiteNetwork", -"description": "Output only. [Output Only] Type of the resource. Alwayscompute#crossSiteNetwork for cross-site networks.", +"default": "compute#compositeHealthCheckList", +"description": "Output only. [Output Only] Type of the resource. Alwayscompute#compositeHealthCheck for composite health checks.", "readOnly": true, "type": "string" }, @@ -49886,14 +50908,481 @@ false "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, -"unreachables": { -"description": "Output only. [Output Only] Unreachable resources.\nend_interface: MixerListResponseWithEtagBuilder", -"items": { -"type": "string" -}, -"readOnly": true, -"type": "array" -}, +"warning": { +"description": "[Output Only] Informational warning message.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"QUOTA_INFO_UNAVAILABLE", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed\noperation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as\ndeprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as\nexperimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden.\nDeprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the\nnetwork.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite\nthe mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g:\nregions.list).", +"The user attempted to use a resource that requires a TOS they have not\naccepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, +"CompositeHealthChecksScopedList": { +"id": "CompositeHealthChecksScopedList", +"properties": { +"compositeHealthChecks": { +"description": "A list of CompositeHealthChecks contained in this scope.", +"items": { +"$ref": "CompositeHealthCheck" +}, +"type": "array" +}, +"warning": { +"description": "Informational warning which replaces the list of composite health checks\nwhen the list is empty.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"QUOTA_INFO_UNAVAILABLE", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed\noperation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as\ndeprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as\nexperimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden.\nDeprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the\nnetwork.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite\nthe mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g:\nregions.list).", +"The user attempted to use a resource that requires a TOS they have not\naccepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, +"ConfidentialInstanceConfig": { +"description": "A set of Confidential Instance options.", +"id": "ConfidentialInstanceConfig", +"properties": { +"confidentialInstanceType": { +"description": "Defines the type of technology used by the confidential instance.", +"enum": [ +"CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED", +"SEV", +"SEV_SNP", +"TDX" +], +"enumDescriptions": [ +"No type specified. Do not use this value.", +"AMD Secure Encrypted Virtualization.", +"AMD Secure Encrypted Virtualization - Secure Nested Paging.", +"Intel Trust Domain eXtension." +], +"type": "string" +}, +"enableConfidentialCompute": { +"description": "Defines whether the instance should have confidential compute enabled.", +"type": "boolean" +} +}, +"type": "object" +}, +"ConnectionDraining": { +"description": "Message containing connection draining configuration.", +"id": "ConnectionDraining", +"properties": { +"drainingTimeoutSec": { +"description": "Configures a duration timeout for existing requests on a removed backend\ninstance. For supported load balancers and protocols, as described inEnabling\nconnection draining.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"ConsistentHashLoadBalancerSettings": { +"description": "This message defines settings for a consistent hash style load balancer.", +"id": "ConsistentHashLoadBalancerSettings", +"properties": { +"httpCookie": { +"$ref": "ConsistentHashLoadBalancerSettingsHttpCookie", +"description": "Hash is based on HTTP Cookie. This field describes a HTTP cookie that will\nbe used as the hash key for the consistent hash load balancer. If the\ncookie is not present, it will be generated. This field is applicable if\nthe sessionAffinity is set to HTTP_COOKIE.\n\nNot supported when the backend service is referenced by a URL map that is\nbound to target gRPC proxy that has validateForProxyless field set to true." +}, +"httpHeaderName": { +"description": "The hash based on the value of the specified header field. This field is\napplicable if the sessionAffinity is set toHEADER_FIELD.", +"type": "string" +}, +"minimumRingSize": { +"description": "The minimum number of virtual nodes to use for the hash ring. Defaults to\n1024. Larger ring sizes result in more granular load distributions. If the\nnumber of hosts in the load balancing pool is larger than the ring size,\neach host will be assigned a single virtual node.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"ConsistentHashLoadBalancerSettingsHttpCookie": { +"description": "The information about the HTTP Cookie on which the hash function is based\nfor load balancing policies that use a consistent hash.", +"id": "ConsistentHashLoadBalancerSettingsHttpCookie", +"properties": { +"name": { +"description": "Name of the cookie.", +"type": "string" +}, +"path": { +"description": "Path to set for the cookie.", +"type": "string" +}, +"ttl": { +"$ref": "Duration", +"description": "Lifetime of the cookie." +} +}, +"type": "object" +}, +"CorsPolicy": { +"description": "The specification for allowing client-side cross-origin requests. For more\ninformation about the W3C recommendation for cross-origin resource sharing\n(CORS), see Fetch API Living\nStandard.", +"id": "CorsPolicy", +"properties": { +"allowCredentials": { +"description": "In response to a preflight request, setting this to true\nindicates that\nthe actual request can include user credentials. This field translates to\nthe Access-Control-Allow-Credentials header.\n\nDefault is false.", +"type": "boolean" +}, +"allowHeaders": { +"description": "Specifies the content for the Access-Control-Allow-Headers\nheader.", +"items": { +"type": "string" +}, +"type": "array" +}, +"allowMethods": { +"description": "Specifies the content for the Access-Control-Allow-Methods\nheader.", +"items": { +"type": "string" +}, +"type": "array" +}, +"allowOriginRegexes": { +"description": "Specifies a regular expression that matches allowed origins. For\nmore information, see regular expression syntax. \n\nAn origin is allowed if it matches either an item inallowOrigins or an item inallowOriginRegexes.\n\nRegular expressions can only be used when the loadBalancingScheme is\nset to INTERNAL_SELF_MANAGED.", +"items": { +"type": "string" +}, +"type": "array" +}, +"allowOrigins": { +"description": "Specifies the list of origins that is allowed to do CORS requests.\n\nAn origin is allowed if it matches either an item inallowOrigins or an item inallowOriginRegexes.", +"items": { +"type": "string" +}, +"type": "array" +}, +"disabled": { +"description": "If true, disables the CORS policy.\nThe default value is false, which indicates that the CORS\npolicy is in effect.", +"type": "boolean" +}, +"exposeHeaders": { +"description": "Specifies the content for the Access-Control-Expose-Headers\nheader.", +"items": { +"type": "string" +}, +"type": "array" +}, +"maxAge": { +"description": "Specifies how long results of a preflight request can be cached in\nseconds. This field translates to the Access-Control-Max-Age\nheader.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"CrossSiteNetwork": { +"description": "A resource that represents a cross-site network.\n\nYou can use cross-site networks to connect your on-premises networks to\neach other through Interconnect connections.", +"id": "CrossSiteNetwork", +"properties": { +"creationTimestamp": { +"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "An optional description of the cross-site network.", +"type": "string" +}, +"id": { +"description": "Output only. [Output Only] The unique identifier for the resource type. The server\ngenerates this identifier.", +"format": "uint64", +"readOnly": true, +"type": "string" +}, +"kind": { +"default": "compute#crossSiteNetwork", +"description": "Output only. [Output Only] Type of the resource. Alwayscompute#crossSiteNetwork for cross-site networks.", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"type": "string" +}, +"selfLink": { +"description": "Output only. [Output Only] Server-defined URL for the resource.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"CrossSiteNetworkList": { +"description": "Response to the list request that contains a list of cross-site networks.", +"id": "CrossSiteNetworkList", +"properties": { +"etag": { +"type": "string" +}, +"id": { +"description": "[Output Only] Unique identifier for the resource; defined by the server.", +"type": "string" +}, +"items": { +"description": "A list of CrossSiteNetwork resources.", +"items": { +"$ref": "CrossSiteNetwork" +}, +"type": "array" +}, +"kind": { +"default": "compute#crossSiteNetwork", +"description": "Output only. [Output Only] Type of the resource. Alwayscompute#crossSiteNetwork for cross-site networks.", +"readOnly": true, +"type": "string" +}, +"nextPageToken": { +"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", +"type": "string" +}, +"selfLink": { +"description": "[Output Only] Server-defined URL for this resource.", +"type": "string" +}, +"unreachables": { +"description": "Output only. [Output Only] Unreachable resources.\nend_interface: MixerListResponseWithEtagBuilder", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "warning": { "description": "[Output Only] Informational warning message.", "properties": { @@ -51671,7 +53160,7 @@ false "type": "string" }, "zones": { -"description": "Zones where the regional managed instance group will create and manage\nits instances.", +"description": "Zones where the regional managed instance group will create and manage\nits instances.\nBy default, a regional MIG doesn't automatically select an AI zone to create\ninstances, even if an AI zone is available in the specified region. To\ncreate instances in an AI zone in the selected region, you must explicitly\nspecify it in the distribution policy together with the other preferred\nzones.", "items": { "$ref": "DistributionPolicyZoneConfiguration" }, @@ -55360,6 +56849,35 @@ false }, "type": "object" }, +"GetVersionOperationMetadata": { +"id": "GetVersionOperationMetadata", +"properties": { +"inlineSbomInfo": { +"$ref": "GetVersionOperationMetadataSbomInfo" +} +}, +"type": "object" +}, +"GetVersionOperationMetadataSbomInfo": { +"id": "GetVersionOperationMetadataSbomInfo", +"properties": { +"currentComponentVersions": { +"additionalProperties": { +"type": "string" +}, +"description": "SBOM versions currently applied to the resource. The key is the component\nname and the value is the version.", +"type": "object" +}, +"targetComponentVersions": { +"additionalProperties": { +"type": "string" +}, +"description": "SBOM versions scheduled for the next maintenance. The key is the\ncomponent name and the value is the version.", +"type": "object" +} +}, +"type": "object" +}, "GlobalAddressesMoveRequest": { "id": "GlobalAddressesMoveRequest", "properties": { @@ -56596,30 +58114,885 @@ false }, "type": "object" }, -"HealthCheckLogConfig": { -"description": "Configuration of logging on a health check. If logging is enabled, logs\nwill be exported to Stackdriver.", -"id": "HealthCheckLogConfig", -"properties": { -"enable": { -"description": "Indicates whether or not to export logs. This is false by default, which\nmeans no health check logging will be done.", -"type": "boolean" -} -}, -"type": "object" -}, -"HealthCheckReference": { -"description": "A full or valid partial URL to a health check. For example, the following are\nvalid URLs:\n \n - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check\n - projects/project-id/global/httpHealthChecks/health-check\n - global/httpHealthChecks/health-check", -"id": "HealthCheckReference", -"properties": { -"healthCheck": { -"type": "string" -} -}, -"type": "object" -}, -"HealthCheckService": { -"description": "Represents a Health-Check as a Service resource.", -"id": "HealthCheckService", +"HealthCheckLogConfig": { +"description": "Configuration of logging on a health check. If logging is enabled, logs\nwill be exported to Stackdriver.", +"id": "HealthCheckLogConfig", +"properties": { +"enable": { +"description": "Indicates whether or not to export logs. This is false by default, which\nmeans no health check logging will be done.", +"type": "boolean" +} +}, +"type": "object" +}, +"HealthCheckReference": { +"description": "A full or valid partial URL to a health check. For example, the following are\nvalid URLs:\n \n - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check\n - projects/project-id/global/httpHealthChecks/health-check\n - global/httpHealthChecks/health-check", +"id": "HealthCheckReference", +"properties": { +"healthCheck": { +"type": "string" +} +}, +"type": "object" +}, +"HealthCheckService": { +"description": "Represents a Health-Check as a Service resource.", +"id": "HealthCheckService", +"properties": { +"creationTimestamp": { +"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "An optional description of this resource. Provide this property when you\ncreate the resource.", +"type": "string" +}, +"fingerprint": { +"description": "Fingerprint of this resource. A hash of the contents stored in this object.\nThis field is used in optimistic locking. This field will be ignored when\ninserting a HealthCheckService. An up-to-date fingerprint must\nbe provided in order to patch/update the HealthCheckService; Otherwise, the\nrequest will fail with error 412 conditionNotMet. To see the\nlatest fingerprint, make a get() request to retrieve the\nHealthCheckService.", +"format": "byte", +"type": "string" +}, +"healthChecks": { +"description": "A list of URLs to the HealthCheck resources. Must have\nat least one HealthCheck, and not more than 10 for regionalHealthCheckService, and not more than 1 for globalHealthCheckService.HealthCheck resources must haveportSpecification=USE_SERVING_PORT orportSpecification=USE_FIXED_PORT. For\nregional HealthCheckService, theHealthCheck must be regional and in the same\nregion. For global HealthCheckService,HealthCheck must be global. Mix of regional and globalHealthChecks is not supported. Multiple regionalHealthChecks must belong to the same region. RegionalHealthChecks must belong to the same region as zones ofNetworkEndpointGroups. For globalHealthCheckService using globalINTERNET_IP_PORT NetworkEndpointGroups, the\nglobal HealthChecks must specify sourceRegions,\nand HealthChecks that specify sourceRegions can\nonly be used with global INTERNET_IP_PORTNetworkEndpointGroups.", +"items": { +"type": "string" +}, +"type": "array" +}, +"healthStatusAggregationPolicy": { +"description": "Optional. Policy for how the results from multiple health checks\nfor the same endpoint are aggregated. Defaults to NO_AGGREGATION\nif unspecified.\n \n - NO_AGGREGATION. An EndpointHealth message is\n returned for each pair in the health check\n service.\n - AND. If any health check of an endpoint reportsUNHEALTHY, then UNHEALTHY is theHealthState of the endpoint. If all health checks reportHEALTHY, the HealthState of the endpoint isHEALTHY.\n\n.\nThis is only allowed with regional HealthCheckService.", +"enum": [ +"AND", +"NO_AGGREGATION" +], +"enumDescriptions": [ +"If any backend's health check reports UNHEALTHY,\nthen UNHEALTHY is the HealthState of\nthe entire health check service. If all backend's are healthy,\nthe HealthState of the health check service isHEALTHY.", +"An EndpointHealth message is returned for each\nbackend in the health check service." +], +"type": "string" +}, +"id": { +"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.", +"format": "uint64", +"readOnly": true, +"type": "string" +}, +"kind": { +"default": "compute#healthCheckService", +"description": "Output only. [Output only] Type of the resource. Alwayscompute#healthCheckServicefor health check services.", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Name of the resource. The name must be 1-63 characters long, and comply\nwith RFC1035. Specifically, the name must be 1-63 characters\nlong and match the regular expression\n`[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character\nmust be a lowercase letter, and all following characters must be a dash,\nlowercase letter, or digit, except the last character, which cannot be a\ndash.", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"type": "string" +}, +"networkEndpointGroups": { +"description": "A list of URLs to the NetworkEndpointGroup\nresources. Must not have more than 100. For regionalHealthCheckService, NEGs must be in\nzones in the region of the HealthCheckService. For globalHealthCheckServices, the NetworkEndpointGroups\nmust be global INTERNET_IP_PORT.", +"items": { +"type": "string" +}, +"type": "array" +}, +"notificationEndpoints": { +"description": "A list of URLs to the NotificationEndpoint\nresources. Must not have more than 10. A list of endpoints for\nreceiving notifications of change in health status. For regionalHealthCheckService,NotificationEndpoint must be regional and in the\nsame region. For global HealthCheckService,NotificationEndpoint must be global.", +"items": { +"type": "string" +}, +"type": "array" +}, +"region": { +"description": "Output only. [Output Only] URL of the region where the health check service\nresides. This field is not applicable to global health check services.\nYou must specify this field as part of the HTTP request URL. It is\nnot settable as a field in the request body.", +"readOnly": true, +"type": "string" +}, +"selfLink": { +"description": "Output only. [Output Only] Server-defined URL for the resource.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"HealthCheckServiceAggregatedList": { +"description": "Contains a list of HealthCheckServicesScopedList.", +"id": "HealthCheckServiceAggregatedList", +"properties": { +"id": { +"description": "[Output Only] Unique identifier for the resource; defined by the server.", +"type": "string" +}, +"items": { +"additionalProperties": { +"$ref": "HealthCheckServicesScopedList", +"description": "Name of the scope containing this set of HealthCheckServices." +}, +"description": "A list of HealthCheckServicesScopedList resources.", +"type": "object" +}, +"kind": { +"default": "compute#healthCheckServiceAggregatedList", +"description": "Output only. Type of resource.", +"readOnly": true, +"type": "string" +}, +"nextPageToken": { +"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", +"type": "string" +}, +"selfLink": { +"description": "Output only. [Output Only] Server-defined URL for this resource.", +"readOnly": true, +"type": "string" +}, +"unreachables": { +"description": "Output only. [Output Only] Unreachable resources.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"warning": { +"description": "[Output Only] Informational warning message.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"QUOTA_INFO_UNAVAILABLE", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed\noperation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as\ndeprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as\nexperimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden.\nDeprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the\nnetwork.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite\nthe mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g:\nregions.list).", +"The user attempted to use a resource that requires a TOS they have not\naccepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, +"HealthCheckServiceReference": { +"description": "A full or valid partial URL to a health check service. For example, the\nfollowing are valid URLs:\n \n - https://www.googleapis.com/compute/beta/projects/project-id/regions/us-west1/healthCheckServices/health-check-service\n - projects/project-id/regions/us-west1/healthCheckServices/health-check-service\n - regions/us-west1/healthCheckServices/health-check-service", +"id": "HealthCheckServiceReference", +"properties": { +"healthCheckService": { +"type": "string" +} +}, +"type": "object" +}, +"HealthCheckServicesList": { +"id": "HealthCheckServicesList", +"properties": { +"id": { +"description": "Output only. [Output Only] Unique identifier for the resource; defined by the server.", +"readOnly": true, +"type": "string" +}, +"items": { +"description": "Output only. A list of HealthCheckService resources.", +"items": { +"$ref": "HealthCheckService" +}, +"readOnly": true, +"type": "array" +}, +"kind": { +"default": "compute#healthCheckServicesList", +"description": "Output only. [Output Only] Type of the resource. Alwayscompute#healthCheckServicesList for lists of\nHealthCheckServices.", +"readOnly": true, +"type": "string" +}, +"nextPageToken": { +"description": "Output only. [Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", +"readOnly": true, +"type": "string" +}, +"selfLink": { +"description": "Output only. [Output Only] Server-defined URL for this resource.", +"readOnly": true, +"type": "string" +}, +"warning": { +"description": "[Output Only] Informational warning message.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"QUOTA_INFO_UNAVAILABLE", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed\noperation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as\ndeprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as\nexperimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden.\nDeprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the\nnetwork.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite\nthe mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g:\nregions.list).", +"The user attempted to use a resource that requires a TOS they have not\naccepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, +"HealthCheckServicesScopedList": { +"id": "HealthCheckServicesScopedList", +"properties": { +"resources": { +"description": "A list of HealthCheckServices contained in this scope.", +"items": { +"$ref": "HealthCheckService" +}, +"type": "array" +}, +"warning": { +"description": "Informational warning which replaces the list of\nbackend services when the list is empty.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"QUOTA_INFO_UNAVAILABLE", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed\noperation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as\ndeprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as\nexperimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden.\nDeprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the\nnetwork.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite\nthe mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g:\nregions.list).", +"The user attempted to use a resource that requires a TOS they have not\naccepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, +"HealthChecksAggregatedList": { +"id": "HealthChecksAggregatedList", +"properties": { +"id": { +"description": "[Output Only] Unique identifier for the resource; defined by the server.", +"type": "string" +}, +"items": { +"additionalProperties": { +"$ref": "HealthChecksScopedList", +"description": "Name of the scope containing this set of HealthChecks." +}, +"description": "A list of HealthChecksScopedList resources.", +"type": "object" +}, +"kind": { +"default": "compute#healthChecksAggregatedList", +"description": "Output only. Type of resource.", +"readOnly": true, +"type": "string" +}, +"nextPageToken": { +"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", +"type": "string" +}, +"selfLink": { +"description": "Output only. [Output Only] Server-defined URL for this resource.", +"readOnly": true, +"type": "string" +}, +"unreachables": { +"description": "Output only. [Output Only] Unreachable resources.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"warning": { +"description": "[Output Only] Informational warning message.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"QUOTA_INFO_UNAVAILABLE", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed\noperation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as\ndeprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as\nexperimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden.\nDeprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the\nnetwork.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite\nthe mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g:\nregions.list).", +"The user attempted to use a resource that requires a TOS they have not\naccepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, +"HealthChecksScopedList": { +"id": "HealthChecksScopedList", +"properties": { +"healthChecks": { +"description": "A list of HealthChecks contained in this scope.", +"items": { +"$ref": "HealthCheck" +}, +"type": "array" +}, +"warning": { +"description": "Informational warning which replaces the list of\nbackend services when the list is empty.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"QUOTA_INFO_UNAVAILABLE", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed\noperation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as\ndeprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as\nexperimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden.\nDeprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the\nnetwork.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite\nthe mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g:\nregions.list).", +"The user attempted to use a resource that requires a TOS they have not\naccepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, +"HealthSource": { +"description": "Represents a health source.\n\nA health source resource specifies the source resources and the health\naggregation policy applied to the source resources to determine the\naggregated health status.", +"id": "HealthSource", "properties": { "creationTimestamp": { "description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.", @@ -56631,62 +59004,33 @@ false "type": "string" }, "fingerprint": { -"description": "Fingerprint of this resource. A hash of the contents stored in this object.\nThis field is used in optimistic locking. This field will be ignored when\ninserting a HealthCheckService. An up-to-date fingerprint must\nbe provided in order to patch/update the HealthCheckService; Otherwise, the\nrequest will fail with error 412 conditionNotMet. To see the\nlatest fingerprint, make a get() request to retrieve the\nHealthCheckService.", +"description": "Fingerprint of this resource. A hash of the contents stored in this object.\nThis field is used in optimistic locking. This field will be ignored when\ninserting a HealthSource. An up-to-date fingerprint\nmust be provided in order to patch the HealthSource; Otherwise, the request\nwill fail with error 412 conditionNotMet. To see the latest\nfingerprint, make a get() request to retrieve the\nHealthSource.", "format": "byte", "type": "string" }, -"healthChecks": { -"description": "A list of URLs to the HealthCheck resources. Must have\nat least one HealthCheck, and not more than 10 for regionalHealthCheckService, and not more than 1 for globalHealthCheckService.HealthCheck resources must haveportSpecification=USE_SERVING_PORT orportSpecification=USE_FIXED_PORT. For\nregional HealthCheckService, theHealthCheck must be regional and in the same\nregion. For global HealthCheckService,HealthCheck must be global. Mix of regional and globalHealthChecks is not supported. Multiple regionalHealthChecks must belong to the same region. RegionalHealthChecks must belong to the same region as zones ofNetworkEndpointGroups. For globalHealthCheckService using globalINTERNET_IP_PORT NetworkEndpointGroups, the\nglobal HealthChecks must specify sourceRegions,\nand HealthChecks that specify sourceRegions can\nonly be used with global INTERNET_IP_PORTNetworkEndpointGroups.", -"items": { -"type": "string" -}, -"type": "array" -}, -"healthStatusAggregationPolicy": { -"description": "Optional. Policy for how the results from multiple health checks\nfor the same endpoint are aggregated. Defaults to NO_AGGREGATION\nif unspecified.\n \n - NO_AGGREGATION. An EndpointHealth message is\n returned for each pair in the health check\n service.\n - AND. If any health check of an endpoint reportsUNHEALTHY, then UNHEALTHY is theHealthState of the endpoint. If all health checks reportHEALTHY, the HealthState of the endpoint isHEALTHY.\n\n.\nThis is only allowed with regional HealthCheckService.", -"enum": [ -"AND", -"NO_AGGREGATION" -], -"enumDescriptions": [ -"If any backend's health check reports UNHEALTHY,\nthen UNHEALTHY is the HealthState of\nthe entire health check service. If all backend's are healthy,\nthe HealthState of the health check service isHEALTHY.", -"An EndpointHealth message is returned for each\nbackend in the health check service." -], +"healthAggregationPolicy": { +"description": "URL to the HealthAggregationPolicy resource. Must be set. Must\nbe regional and in the same region as the HealthSource. Can be\nmutated.", "type": "string" }, "id": { -"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.", +"description": "Output only. [Output Only] A unique identifier for this resource type. The server\ngenerates this identifier.", "format": "uint64", "readOnly": true, "type": "string" }, "kind": { -"default": "compute#healthCheckService", -"description": "Output only. [Output only] Type of the resource. Alwayscompute#healthCheckServicefor health check services.", +"default": "compute#healthSource", +"description": "Output only. [Output Only] Type of the resource. Alwayscompute#healthSource for health sources.", "readOnly": true, "type": "string" }, "name": { -"description": "Name of the resource. The name must be 1-63 characters long, and comply\nwith RFC1035. Specifically, the name must be 1-63 characters\nlong and match the regular expression\n`[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character\nmust be a lowercase letter, and all following characters must be a dash,\nlowercase letter, or digit, except the last character, which cannot be a\ndash.", +"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, -"networkEndpointGroups": { -"description": "A list of URLs to the NetworkEndpointGroup\nresources. Must not have more than 100. For regionalHealthCheckService, NEGs must be in\nzones in the region of the HealthCheckService. For globalHealthCheckServices, the NetworkEndpointGroups\nmust be global INTERNET_IP_PORT.", -"items": { -"type": "string" -}, -"type": "array" -}, -"notificationEndpoints": { -"description": "A list of URLs to the NotificationEndpoint\nresources. Must not have more than 10. A list of endpoints for\nreceiving notifications of change in health status. For regionalHealthCheckService,NotificationEndpoint must be regional and in the\nsame region. For global HealthCheckService,NotificationEndpoint must be global.", -"items": { -"type": "string" -}, -"type": "array" -}, "region": { -"description": "Output only. [Output Only] URL of the region where the health check service\nresides. This field is not applicable to global health check services.\nYou must specify this field as part of the HTTP request URL. It is\nnot settable as a field in the request body.", +"description": "Output only. [Output Only] URL of the region where the health source resides.\nThis field applies only to the regional resource. You must specify this\nfield as part of the HTTP request URL. It is not settable as a field in\nthe request body.", "readOnly": true, "type": "string" }, @@ -56694,45 +59038,56 @@ false "description": "Output only. [Output Only] Server-defined URL for the resource.", "readOnly": true, "type": "string" -} }, -"type": "object" +"selfLinkWithId": { +"description": "Output only. [Output Only] Server-defined URL with id for the resource.", +"readOnly": true, +"type": "string" }, -"HealthCheckServiceReference": { -"description": "A full or valid partial URL to a health check service. For example, the\nfollowing are valid URLs:\n \n - https://www.googleapis.com/compute/beta/projects/project-id/regions/us-west1/healthCheckServices/health-check-service\n - projects/project-id/regions/us-west1/healthCheckServices/health-check-service\n - regions/us-west1/healthCheckServices/health-check-service", -"id": "HealthCheckServiceReference", -"properties": { -"healthCheckService": { +"sourceType": { +"description": "Specifies the type of the HealthSource. The only allowed value\nis BACKEND_SERVICE. Must be specified when theHealthSource is created, and cannot be mutated.", +"enum": [ +"BACKEND_SERVICE" +], +"enumDescriptions": [ +"" +], "type": "string" +}, +"sources": { +"description": "URLs to the source resources. Must be size 1. Must be aBackendService if\nthe sourceType is BACKEND_SERVICE. TheBackendService must have load balancing schemeINTERNAL or INTERNAL_MANAGED and must be regional\nand in the same region as the HealthSource (cross-region\ndeployment for INTERNAL_MANAGED is not supported). TheBackendService may use only IGs, MIGs, or NEGs of typeGCE_VM_IP or GCE_VM_IP_PORT. TheBackendService may not use haPolicy. Can be\nmutated.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" }, -"HealthCheckServicesList": { -"id": "HealthCheckServicesList", +"HealthSourceAggregatedList": { +"description": "Contains a list of HealthSourcesScopedList.", +"id": "HealthSourceAggregatedList", "properties": { "id": { -"description": "Output only. [Output Only] Unique identifier for the resource; defined by the server.", -"readOnly": true, +"description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { -"description": "Output only. A list of HealthCheckService resources.", -"items": { -"$ref": "HealthCheckService" +"additionalProperties": { +"$ref": "HealthSourcesScopedList", +"description": "Name of the scope containing this set of HealthSources." }, -"readOnly": true, -"type": "array" +"description": "A list of HealthSourcesScopedList resources.", +"type": "object" }, "kind": { -"default": "compute#healthCheckServicesList", -"description": "Output only. [Output Only] Type of the resource. Alwayscompute#healthCheckServicesList for lists of\nHealthCheckServices.", +"default": "compute#healthSourceAggregatedList", +"description": "Output only. Type of resource.", "readOnly": true, "type": "string" }, "nextPageToken": { -"description": "Output only. [Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", -"readOnly": true, +"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", "type": "string" }, "selfLink": { @@ -56740,6 +59095,14 @@ false "readOnly": true, "type": "string" }, +"unreachables": { +"description": "Output only. [Output Only] Unreachable resources.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "warning": { "description": "[Output Only] Informational warning message.", "properties": { @@ -56867,24 +59230,23 @@ false }, "type": "object" }, -"HealthChecksAggregatedList": { -"id": "HealthChecksAggregatedList", +"HealthSourceList": { +"id": "HealthSourceList", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { -"additionalProperties": { -"$ref": "HealthChecksScopedList", -"description": "Name of the scope containing this set of HealthChecks." +"description": "A list of HealthSource resources.", +"items": { +"$ref": "HealthSource" }, -"description": "A list of HealthChecksScopedList resources.", -"type": "object" +"type": "array" }, "kind": { -"default": "compute#healthChecksAggregatedList", -"description": "Output only. Type of resource.", +"default": "compute#healthSourceList", +"description": "Output only. [Output Only] Type of the resource. Alwayscompute#healthSource for health sources.", "readOnly": true, "type": "string" }, @@ -56893,18 +59255,9 @@ false "type": "string" }, "selfLink": { -"description": "Output only. [Output Only] Server-defined URL for this resource.", -"readOnly": true, -"type": "string" -}, -"unreachables": { -"description": "Output only. [Output Only] Unreachable resources.", -"items": { +"description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, -"readOnly": true, -"type": "array" -}, "warning": { "description": "[Output Only] Informational warning message.", "properties": { @@ -57032,18 +59385,18 @@ false }, "type": "object" }, -"HealthChecksScopedList": { -"id": "HealthChecksScopedList", +"HealthSourcesScopedList": { +"id": "HealthSourcesScopedList", "properties": { -"healthChecks": { -"description": "A list of HealthChecks contained in this scope.", +"healthSources": { +"description": "A list of HealthSources contained in this scope.", "items": { -"$ref": "HealthCheck" +"$ref": "HealthSource" }, "type": "array" }, "warning": { -"description": "Informational warning which replaces the list of\nbackend services when the list is empty.", +"description": "Informational warning which replaces the list of\nhealth sources when the list is empty.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", @@ -59712,6 +62065,10 @@ false "format": "int32", "type": "integer" }, +"targetSizePolicy": { +"$ref": "InstanceGroupManagerTargetSizePolicy", +"description": "The policy that specifies how the MIG creates its VMs to achieve the target\nsize." +}, "targetStoppedSize": { "description": "The target number of stopped instances for this managed instance group.\nThis number changes when you: \n \n - Stop instance using the stopInstances\n method or start instances using the startInstances\n method.\n - Manually change the targetStoppedSize using the update\n method.", "format": "int32", @@ -60657,11 +63014,24 @@ false "description": "Output only. [Output only] Status of all-instances configuration on the group.", "readOnly": true }, +"appliedAcceleratorTopologies": { +"description": "Output only. [Output Only] The accelerator topology applied to this MIG.\nCurrently only one accelerator topology is supported.", +"items": { +"$ref": "InstanceGroupManagerStatusAcceleratorTopology" +}, +"readOnly": true, +"type": "array" +}, "autoscaler": { "description": "Output only. [Output Only] The URL of theAutoscaler\nthat targets this instance group manager.", "readOnly": true, "type": "string" }, +"bulkInstanceOperation": { +"$ref": "InstanceGroupManagerStatusBulkInstanceOperation", +"description": "Output only. [Output Only] The status of bulk instance operation.", +"readOnly": true +}, "isStable": { "description": "Output only. [Output Only] A bit indicating whether the managed instance group is in a\nstable state. A stable state means that: none of the instances in the\nmanaged instance group is currently undergoing any type of change (for\nexample, creation, restart, or deletion); no future changes are scheduled\nfor instances in the managed instance group; and the managed instance\ngroup itself is not being modified.", "readOnly": true, @@ -60680,6 +63050,104 @@ false }, "type": "object" }, +"InstanceGroupManagerStatusAcceleratorTopology": { +"id": "InstanceGroupManagerStatusAcceleratorTopology", +"properties": { +"acceleratorTopology": { +"description": "Output only. [Output Only] Topology in the format of: \"16x16\", \"4x4x4\", etc.\nThe value is the same as configured in the WorkloadPolicy.", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. [Output Only] The state of the accelerator topology.", +"enum": [ +"ACTIVATING", +"ACTIVE", +"DEACTIVATING", +"FAILED", +"INCOMPLETE", +"REACTIVATING" +], +"enumDescriptions": [ +"The accelerator topology is being activated.", +"The accelerator topology is active.", +"The accelerator topology is being deactivated.", +"The accelerator topology failed.", +"The configuration is incomplete and the accelerator topology cannot\nbe activated due to insufficient number of running VMs.", +"The accelerator topology is being reactivated." +], +"readOnly": true, +"type": "string" +}, +"stateDetails": { +"$ref": "InstanceGroupManagerStatusAcceleratorTopologyAcceleratorTopologyStateDetails", +"description": "Output only. [Output Only] The result of the latest accelerator topology state\ncheck.", +"readOnly": true +} +}, +"type": "object" +}, +"InstanceGroupManagerStatusAcceleratorTopologyAcceleratorTopologyStateDetails": { +"id": "InstanceGroupManagerStatusAcceleratorTopologyAcceleratorTopologyStateDetails", +"properties": { +"error": { +"description": "Output only. [Output Only] Encountered errors.", +"properties": { +"errors": { +"description": "[Output Only] The array of errors encountered while processing this\noperation.", +"items": { +"properties": { +"code": { +"description": "[Output Only] The error type identifier for this error.", +"type": "string" +}, +"errorDetails": { +"description": "[Output Only] An optional list of messages that contain the error\ndetails. There is a set of defined message types to use for providing\ndetails.The syntax depends on the error code. For example,\nQuotaExceededInfo will have details when the error code is\nQUOTA_EXCEEDED.", +"items": { +"properties": { +"errorInfo": { +"$ref": "ErrorInfo" +}, +"help": { +"$ref": "Help" +}, +"localizedMessage": { +"$ref": "LocalizedMessage" +}, +"quotaInfo": { +"$ref": "QuotaExceededInfo" +} +}, +"type": "object" +}, +"type": "array" +}, +"location": { +"description": "[Output Only] Indicates the field in the request that caused the error.\nThis property is optional.", +"type": "string" +}, +"message": { +"description": "[Output Only] An optional, human-readable error message.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +} +}, +"readOnly": true, +"type": "object" +}, +"timestamp": { +"description": "Output only. [Output Only] Timestamp is shown only if there is an error. The field\nhas // RFC3339 //\ntext format.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "InstanceGroupManagerStatusAllInstancesConfig": { "id": "InstanceGroupManagerStatusAllInstancesConfig", "properties": { @@ -60696,6 +63164,84 @@ false }, "type": "object" }, +"InstanceGroupManagerStatusBulkInstanceOperation": { +"description": "Bulk instance operation is the creation of VMs in a MIG when the\ntargetSizePolicy.mode is set to BULK.", +"id": "InstanceGroupManagerStatusBulkInstanceOperation", +"properties": { +"inProgress": { +"description": "Output only. [Output Only] Informs whether bulk instance operation is in progress.", +"readOnly": true, +"type": "boolean" +}, +"lastProgressCheck": { +"$ref": "InstanceGroupManagerStatusBulkInstanceOperationLastProgressCheck", +"description": "Output only. [Output Only] Information from the last progress check of bulk instance\noperation.", +"readOnly": true +} +}, +"type": "object" +}, +"InstanceGroupManagerStatusBulkInstanceOperationLastProgressCheck": { +"id": "InstanceGroupManagerStatusBulkInstanceOperationLastProgressCheck", +"properties": { +"error": { +"description": "Output only. [Output Only] Errors encountered during bulk instance operation.", +"properties": { +"errors": { +"description": "[Output Only] The array of errors encountered while processing this\noperation.", +"items": { +"properties": { +"code": { +"description": "[Output Only] The error type identifier for this error.", +"type": "string" +}, +"errorDetails": { +"description": "[Output Only] An optional list of messages that contain the error\ndetails. There is a set of defined message types to use for providing\ndetails.The syntax depends on the error code. For example,\nQuotaExceededInfo will have details when the error code is\nQUOTA_EXCEEDED.", +"items": { +"properties": { +"errorInfo": { +"$ref": "ErrorInfo" +}, +"help": { +"$ref": "Help" +}, +"localizedMessage": { +"$ref": "LocalizedMessage" +}, +"quotaInfo": { +"$ref": "QuotaExceededInfo" +} +}, +"type": "object" +}, +"type": "array" +}, +"location": { +"description": "[Output Only] Indicates the field in the request that caused the error.\nThis property is optional.", +"type": "string" +}, +"message": { +"description": "[Output Only] An optional, human-readable error message.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +} +}, +"readOnly": true, +"type": "object" +}, +"timestamp": { +"description": "Output only. [Output Only] Timestamp of the last progress check of bulk instance\noperation. Timestamp is in RFC3339 text format.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "InstanceGroupManagerStatusStateful": { "id": "InstanceGroupManagerStatusStateful", "properties": { @@ -60734,6 +63280,26 @@ false }, "type": "object" }, +"InstanceGroupManagerTargetSizePolicy": { +"id": "InstanceGroupManagerTargetSizePolicy", +"properties": { +"mode": { +"description": "The mode of target size policy based on which the MIG creates its VMs\nindividually or all at once.", +"enum": [ +"BULK", +"INDIVIDUAL", +"UNSPECIFIED_MODE" +], +"enumDescriptions": [ +"The mode in which the MIG creates VMs all at once. In this mode, if the\nMIG is unable to create even one VM, the MIG waits until all VMs can be\ncreated at the same time.", +"The mode in which the MIG creates VMs individually. In this mode, if\nthe MIG is unable to create a VM, the MIG will continue to create the\nother VMs in the group. This is the default mode.", +"If mode is unspecified, MIG will behave as in the default `INDIVIDUAL`\nmode." +], +"type": "string" +} +}, +"type": "object" +}, "InstanceGroupManagerUpdatePolicy": { "id": "InstanceGroupManagerUpdatePolicy", "properties": { @@ -75180,24 +77746,366 @@ false }, "type": "object" }, -"NodeTypeList": { -"description": "Contains a list of node types.", -"id": "NodeTypeList", +"NodeTypeList": { +"description": "Contains a list of node types.", +"id": "NodeTypeList", +"properties": { +"id": { +"description": "[Output Only] Unique identifier for the resource; defined by the server.", +"type": "string" +}, +"items": { +"description": "A list of NodeType resources.", +"items": { +"$ref": "NodeType" +}, +"type": "array" +}, +"kind": { +"default": "compute#nodeTypeList", +"description": "Output only. [Output Only] Type of resource.Always compute#nodeTypeList for\nlists of node types.", +"readOnly": true, +"type": "string" +}, +"nextPageToken": { +"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", +"type": "string" +}, +"selfLink": { +"description": "Output only. [Output Only] Server-defined URL for this resource.", +"readOnly": true, +"type": "string" +}, +"warning": { +"description": "[Output Only] Informational warning message.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"QUOTA_INFO_UNAVAILABLE", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed\noperation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as\ndeprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as\nexperimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden.\nDeprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the\nnetwork.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite\nthe mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g:\nregions.list).", +"The user attempted to use a resource that requires a TOS they have not\naccepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, +"NodeTypesScopedList": { +"id": "NodeTypesScopedList", +"properties": { +"nodeTypes": { +"description": "[Output Only] A list of node types contained in this scope.", +"items": { +"$ref": "NodeType" +}, +"type": "array" +}, +"warning": { +"description": "[Output Only] An informational warning that appears when the node types\nlist is empty.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"QUOTA_INFO_UNAVAILABLE", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed\noperation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as\ndeprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as\nexperimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden.\nDeprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the\nnetwork.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite\nthe mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g:\nregions.list).", +"The user attempted to use a resource that requires a TOS they have not\naccepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, +"NotificationEndpoint": { +"description": "Represents a notification endpoint.\n\nA notification endpoint resource defines an endpoint to receive notifications\nwhen there are status changes detected by the associated health check\nservice.\n\nFor more information, see\nHealth checks overview.", +"id": "NotificationEndpoint", +"properties": { +"creationTimestamp": { +"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "An optional description of this resource. Provide this property when you\ncreate the resource.", +"type": "string" +}, +"grpcSettings": { +"$ref": "NotificationEndpointGrpcSettings", +"description": "Settings of the gRPC notification endpoint including the endpoint URL and\nthe retry duration." +}, +"id": { +"description": "Output only. [Output Only] A unique identifier for this resource type. The server\ngenerates this identifier.", +"format": "uint64", +"readOnly": true, +"type": "string" +}, +"kind": { +"default": "compute#notificationEndpoint", +"description": "Output only. [Output Only] Type of the resource. Alwayscompute#notificationEndpoint for notification endpoints.", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"type": "string" +}, +"region": { +"description": "Output only. [Output Only] URL of the region where the notification endpoint resides.\nThis field applies only to the regional resource. You must specify this\nfield as part of the HTTP request URL. It is not settable as a field in\nthe request body.", +"readOnly": true, +"type": "string" +}, +"selfLink": { +"description": "Output only. [Output Only] Server-defined URL for the resource.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"NotificationEndpointAggregatedList": { +"description": "Contains a list of NotificationEndpointsScopedList.", +"id": "NotificationEndpointAggregatedList", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { -"description": "A list of NodeType resources.", -"items": { -"$ref": "NodeType" +"additionalProperties": { +"$ref": "NotificationEndpointsScopedList", +"description": "Name of the scope containing this set of NotificationEndpoints." }, -"type": "array" +"description": "A list of NotificationEndpointsScopedList resources.", +"type": "object" }, "kind": { -"default": "compute#nodeTypeList", -"description": "Output only. [Output Only] Type of resource.Always compute#nodeTypeList for\nlists of node types.", +"default": "compute#notificationEndpointAggregatedList", +"description": "Output only. Type of resource.", "readOnly": true, "type": "string" }, @@ -75210,6 +78118,14 @@ false "readOnly": true, "type": "string" }, +"unreachables": { +"description": "Output only. [Output Only] Unreachable resources.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "warning": { "description": "[Output Only] Informational warning message.", "properties": { @@ -75337,18 +78253,64 @@ false }, "type": "object" }, -"NodeTypesScopedList": { -"id": "NodeTypesScopedList", +"NotificationEndpointGrpcSettings": { +"description": "Represents a gRPC setting that describes one gRPC notification endpoint and\nthe retry duration attempting to send notification to this endpoint.", +"id": "NotificationEndpointGrpcSettings", "properties": { -"nodeTypes": { -"description": "[Output Only] A list of node types contained in this scope.", +"authority": { +"description": "Optional. If specified, this field is used to set the authority header by\nthe sender of notifications. See\nhttps://tools.ietf.org/html/rfc7540#section-8.1.2.3", +"type": "string" +}, +"endpoint": { +"description": "Endpoint to which gRPC notifications are sent. This must be a valid\ngRPCLB DNS name.", +"type": "string" +}, +"payloadName": { +"description": "Optional. If specified, this field is used to populate the \"name\" field\nin gRPC requests.", +"type": "string" +}, +"resendInterval": { +"$ref": "Duration", +"description": "Optional. This field is used to configure how often to send a full update\nof all non-healthy backends. If unspecified, full updates are not sent.\nIf specified, must be in the range between 600 seconds to 3600 seconds.\nNanos are disallowed. Can only be set for regional notification\nendpoints." +}, +"retryDurationSec": { +"description": "How much time (in seconds) is spent attempting notification retries\nuntil a successful response is received. Default is 30s. Limit is 20m\n(1200s). Must be a positive number.", +"format": "uint32", +"type": "integer" +} +}, +"type": "object" +}, +"NotificationEndpointList": { +"id": "NotificationEndpointList", +"properties": { +"id": { +"description": "[Output Only] Unique identifier for the resource; defined by the server.", +"type": "string" +}, "items": { -"$ref": "NodeType" +"description": "A list of NotificationEndpoint resources.", +"items": { +"$ref": "NotificationEndpoint" }, "type": "array" }, +"kind": { +"default": "compute#notificationEndpointList", +"description": "Output only. [Output Only] Type of the resource. Alwayscompute#notificationEndpoint for notification endpoints.", +"readOnly": true, +"type": "string" +}, +"nextPageToken": { +"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", +"type": "string" +}, +"selfLink": { +"description": "[Output Only] Server-defined URL for this resource.", +"type": "string" +}, "warning": { -"description": "[Output Only] An informational warning that appears when the node types\nlist is empty.", +"description": "[Output Only] Informational warning message.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", @@ -75474,111 +78436,18 @@ false }, "type": "object" }, -"NotificationEndpoint": { -"description": "Represents a notification endpoint.\n\nA notification endpoint resource defines an endpoint to receive notifications\nwhen there are status changes detected by the associated health check\nservice.\n\nFor more information, see\nHealth checks overview.", -"id": "NotificationEndpoint", +"NotificationEndpointsScopedList": { +"id": "NotificationEndpointsScopedList", "properties": { -"creationTimestamp": { -"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.", -"readOnly": true, -"type": "string" -}, -"description": { -"description": "An optional description of this resource. Provide this property when you\ncreate the resource.", -"type": "string" -}, -"grpcSettings": { -"$ref": "NotificationEndpointGrpcSettings", -"description": "Settings of the gRPC notification endpoint including the endpoint URL and\nthe retry duration." -}, -"id": { -"description": "Output only. [Output Only] A unique identifier for this resource type. The server\ngenerates this identifier.", -"format": "uint64", -"readOnly": true, -"type": "string" -}, -"kind": { -"default": "compute#notificationEndpoint", -"description": "Output only. [Output Only] Type of the resource. Alwayscompute#notificationEndpoint for notification endpoints.", -"readOnly": true, -"type": "string" -}, -"name": { -"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"type": "string" -}, -"region": { -"description": "Output only. [Output Only] URL of the region where the notification endpoint resides.\nThis field applies only to the regional resource. You must specify this\nfield as part of the HTTP request URL. It is not settable as a field in\nthe request body.", -"readOnly": true, -"type": "string" -}, -"selfLink": { -"description": "Output only. [Output Only] Server-defined URL for the resource.", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"NotificationEndpointGrpcSettings": { -"description": "Represents a gRPC setting that describes one gRPC notification endpoint and\nthe retry duration attempting to send notification to this endpoint.", -"id": "NotificationEndpointGrpcSettings", -"properties": { -"authority": { -"description": "Optional. If specified, this field is used to set the authority header by\nthe sender of notifications. See\nhttps://tools.ietf.org/html/rfc7540#section-8.1.2.3", -"type": "string" -}, -"endpoint": { -"description": "Endpoint to which gRPC notifications are sent. This must be a valid\ngRPCLB DNS name.", -"type": "string" -}, -"payloadName": { -"description": "Optional. If specified, this field is used to populate the \"name\" field\nin gRPC requests.", -"type": "string" -}, -"resendInterval": { -"$ref": "Duration", -"description": "Optional. This field is used to configure how often to send a full update\nof all non-healthy backends. If unspecified, full updates are not sent.\nIf specified, must be in the range between 600 seconds to 3600 seconds.\nNanos are disallowed. Can only be set for regional notification\nendpoints." -}, -"retryDurationSec": { -"description": "How much time (in seconds) is spent attempting notification retries\nuntil a successful response is received. Default is 30s. Limit is 20m\n(1200s). Must be a positive number.", -"format": "uint32", -"type": "integer" -} -}, -"type": "object" -}, -"NotificationEndpointList": { -"id": "NotificationEndpointList", -"properties": { -"id": { -"description": "[Output Only] Unique identifier for the resource; defined by the server.", -"type": "string" -}, -"items": { -"description": "A list of NotificationEndpoint resources.", +"resources": { +"description": "A list of NotificationEndpoints contained in this scope.", "items": { "$ref": "NotificationEndpoint" }, "type": "array" }, -"kind": { -"default": "compute#notificationEndpointList", -"description": "Output only. [Output Only] Type of the resource. Alwayscompute#notificationEndpoint for notification endpoints.", -"readOnly": true, -"type": "string" -}, -"nextPageToken": { -"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", -"type": "string" -}, -"selfLink": { -"description": "[Output Only] Server-defined URL for this resource.", -"type": "string" -}, "warning": { -"description": "[Output Only] Informational warning message.", +"description": "Informational warning which replaces the list of\nnotification endpoints when the list is empty.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", @@ -75772,6 +78641,9 @@ false }, "type": "object" }, +"getVersionOperationMetadata": { +"$ref": "GetVersionOperationMetadata" +}, "httpErrorMessage": { "description": "[Output Only] If the operation fails, this field contains the HTTP error\nmessage that was returned, such as `NOT FOUND`.", "type": "string" @@ -82401,6 +85273,29 @@ false }, "type": "object" }, +"ReservationSlotsGetVersionRequest": { +"id": "ReservationSlotsGetVersionRequest", +"properties": { +"sbomSelections": { +"description": "The SBOM selection to return. Duplicate values in the list will be ignored.", +"items": { +"enum": [ +"SBOM_SELECTION_CURRENT", +"SBOM_SELECTION_TARGET", +"SBOM_SELECTION_UNSPECIFIED" +], +"enumDescriptions": [ +"", +"", +"" +], +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "ReservationSlotsListResponse": { "description": "A list of reservation slots within a single reservation.", "id": "ReservationSlotsListResponse", @@ -82723,6 +85618,29 @@ false }, "type": "object" }, +"ReservationSubBlocksGetVersionRequest": { +"id": "ReservationSubBlocksGetVersionRequest", +"properties": { +"sbomSelections": { +"description": "The SBOM selection to return.", +"items": { +"enum": [ +"SBOM_SELECTION_CURRENT", +"SBOM_SELECTION_TARGET", +"SBOM_SELECTION_UNSPECIFIED" +], +"enumDescriptions": [ +"", +"", +"" +], +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "ReservationSubBlocksListResponse": { "description": "A list of reservation subBlocks under a single reservation.", "id": "ReservationSubBlocksListResponse", @@ -84047,6 +86965,18 @@ false "description": "Specifies the topology required to create a partition for VMs that have\ninterconnected GPUs.", "type": "string" }, +"acceleratorTopologyMode": { +"description": "Specifies the connection mode for the accelerator topology. If not\nspecified, the default is AUTO_CONNECT.", +"enum": [ +"AUTO_CONNECT", +"PROVISION_ONLY" +], +"enumDescriptions": [ +"The interconnected chips are pre-configured at the time of VM creation.", +"The interconnected chips are connected on demand. At the time of VM\ncreation, the chips are not connected." +], +"type": "string" +}, "maxTopologyDistance": { "description": "Specifies the maximum distance between instances.", "enum": [ @@ -88831,6 +91761,10 @@ false "description": "The url of a connected endpoint.", "type": "string" }, +"endpointWithId": { +"description": "The url of a connected endpoint with resource id.", +"type": "string" +}, "natIps": { "description": "NAT IPs of the connected PSC endpoint and those of other endpoints\npropagated from it.", "items": { @@ -88879,6 +91813,10 @@ false "format": "uint32", "type": "integer" }, +"endpointUrl": { +"description": "The URL for the PSC endpoint to accept", +"type": "string" +}, "networkUrl": { "description": "The network URL for the network to set the limit for.", "type": "string" @@ -91123,7 +94061,7 @@ false "type": "string" }, "profile": { -"description": "Profile specifies the set of SSL features that can be used by the load\nbalancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features\nto enable must be specified in the customFeatures field.", +"description": "Profile specifies the set of SSL features that can be used by the load\nbalancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED,FIPS_202205, or CUSTOM. If usingCUSTOM, the set of SSL features to enable must be specified in\nthe customFeatures field. If using FIPS_202205,\nthe min_tls_version field must be set to TLS_1_2.", "enum": [ "COMPATIBLE", "CUSTOM", From 67f740990a1cd40801a08f04278d245ab6fb87eb Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 10 Mar 2026 07:24:05 +0000 Subject: [PATCH 10/31] feat(datamigration): update the api #### datamigration:v1 The following keys were added: - endpoints (Total Keys: 1) #### datamigration:v1beta1 The following keys were added: - endpoints (Total Keys: 1) --- .../documents/datamigration.v1.json | 239 +++++++++++++++++- .../documents/datamigration.v1beta1.json | 239 +++++++++++++++++- 2 files changed, 476 insertions(+), 2 deletions(-) diff --git a/googleapiclient/discovery_cache/documents/datamigration.v1.json b/googleapiclient/discovery_cache/documents/datamigration.v1.json index 7419727769..8720fb0015 100644 --- a/googleapiclient/discovery_cache/documents/datamigration.v1.json +++ b/googleapiclient/discovery_cache/documents/datamigration.v1.json @@ -15,6 +15,243 @@ "description": "Manage Cloud Database Migration Service resources on Google Cloud Platform.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/database-migration/", +"endpoints": [ +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.africa-south1.rep.googleapis.com/", +"location": "africa-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.asia-northeast2.rep.googleapis.com/", +"location": "asia-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.asia-southeast3.rep.googleapis.com/", +"location": "asia-southeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.europe-north2.rep.googleapis.com/", +"location": "europe-north2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.europe-west10.rep.googleapis.com/", +"location": "europe-west10" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.europe-west12.rep.googleapis.com/", +"location": "europe-west12" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.europe-west15.rep.googleapis.com/", +"location": "europe-west15" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.europe-west3.rep.googleapis.com/", +"location": "europe-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.europe-west8.rep.googleapis.com/", +"location": "europe-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.europe-west9.rep.googleapis.com/", +"location": "europe-west9" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.me-central2.rep.googleapis.com/", +"location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.me-west1.rep.googleapis.com/", +"location": "me-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.northamerica-south1.rep.googleapis.com/", +"location": "northamerica-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.us-central2.rep.googleapis.com/", +"location": "us-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.us-east7.rep.googleapis.com/", +"location": "us-east7" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.us-west4.rep.googleapis.com/", +"location": "us-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.us-west8.rep.googleapis.com/", +"location": "us-west8" +} +], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -2350,7 +2587,7 @@ } } }, -"revision": "20260127", +"revision": "20260225", "rootUrl": "https://datamigration.googleapis.com/", "schemas": { "AlloyDbConnectionProfile": { diff --git a/googleapiclient/discovery_cache/documents/datamigration.v1beta1.json b/googleapiclient/discovery_cache/documents/datamigration.v1beta1.json index feb523fff4..b53254eddb 100644 --- a/googleapiclient/discovery_cache/documents/datamigration.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/datamigration.v1beta1.json @@ -15,6 +15,243 @@ "description": "Manage Cloud Database Migration Service resources on Google Cloud Platform.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/database-migration/", +"endpoints": [ +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.africa-south1.rep.googleapis.com/", +"location": "africa-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.asia-northeast2.rep.googleapis.com/", +"location": "asia-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.asia-southeast3.rep.googleapis.com/", +"location": "asia-southeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.europe-north2.rep.googleapis.com/", +"location": "europe-north2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.europe-west10.rep.googleapis.com/", +"location": "europe-west10" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.europe-west12.rep.googleapis.com/", +"location": "europe-west12" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.europe-west15.rep.googleapis.com/", +"location": "europe-west15" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.europe-west3.rep.googleapis.com/", +"location": "europe-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.europe-west8.rep.googleapis.com/", +"location": "europe-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.europe-west9.rep.googleapis.com/", +"location": "europe-west9" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.me-central2.rep.googleapis.com/", +"location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.me-west1.rep.googleapis.com/", +"location": "me-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.northamerica-south1.rep.googleapis.com/", +"location": "northamerica-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.us-central2.rep.googleapis.com/", +"location": "us-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.us-east7.rep.googleapis.com/", +"location": "us-east7" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.us-west4.rep.googleapis.com/", +"location": "us-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datamigration.us-west8.rep.googleapis.com/", +"location": "us-west8" +} +], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -1060,7 +1297,7 @@ } } }, -"revision": "20260127", +"revision": "20260225", "rootUrl": "https://datamigration.googleapis.com/", "schemas": { "AuditConfig": { From bda576f8d92d530bb09f1f73bfe04e1f53dc8a82 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 10 Mar 2026 07:24:05 +0000 Subject: [PATCH 11/31] feat(dataplex): update the api #### dataplex:v1 The following keys were added: - resources.projects.resources.locations.resources.entryGroups.resources.entryLinks.methods.patch (Total Keys: 17) - schemas.GoogleCloudDataplexV1EntryLink.properties.aspects (Total Keys: 2) --- ...ects.locations.entryGroups.entryLinks.html | 155 +++++++++++++++++- docs/dyn/dataplex_v1.projects.locations.html | 18 +- .../documents/dataplex.v1.json | 50 +++++- 3 files changed, 216 insertions(+), 7 deletions(-) diff --git a/docs/dyn/dataplex_v1.projects.locations.entryGroups.entryLinks.html b/docs/dyn/dataplex_v1.projects.locations.entryGroups.entryLinks.html index a3fadd9c31..d3ea946c38 100644 --- a/docs/dyn/dataplex_v1.projects.locations.entryGroups.entryLinks.html +++ b/docs/dyn/dataplex_v1.projects.locations.entryGroups.entryLinks.html @@ -86,6 +86,9 @@

Instance Methods

get(name, x__xgafv=None)

Gets an Entry Link.

+

+ patch(name, allowMissing=None, aspectKeys=None, body=None, x__xgafv=None)

+

Updates an Entry Link.

Method Details

close() @@ -102,9 +105,25 @@

Method Details

The object takes the form of: { # EntryLink represents a link between two Entries. + "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed. + "a_key": { # An aspect is a single piece of metadata describing an entry. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, "createTime": "A String", # Output only. The time when the Entry Link was created. "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition - "entryReferences": [ # Required. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references. + "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references. { # Reference to the Entry that is linked through the Entry Link. "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link. @@ -125,9 +144,25 @@

Method Details

An object of the form: { # EntryLink represents a link between two Entries. + "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed. + "a_key": { # An aspect is a single piece of metadata describing an entry. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, "createTime": "A String", # Output only. The time when the Entry Link was created. "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition - "entryReferences": [ # Required. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references. + "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references. { # Reference to the Entry that is linked through the Entry Link. "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link. @@ -154,9 +189,25 @@

Method Details

An object of the form: { # EntryLink represents a link between two Entries. + "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed. + "a_key": { # An aspect is a single piece of metadata describing an entry. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, "createTime": "A String", # Output only. The time when the Entry Link was created. "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition - "entryReferences": [ # Required. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references. + "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references. { # Reference to the Entry that is linked through the Entry Link. "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link. @@ -183,9 +234,105 @@

Method Details

An object of the form: { # EntryLink represents a link between two Entries. + "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed. + "a_key": { # An aspect is a single piece of metadata describing an entry. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the Entry Link was created. + "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition + "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references. + { # Reference to the Entry that is linked through the Entry Link. + "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link. + "type": "A String", # Required. Immutable. The reference type of the Entry. + }, + ], + "name": "A String", # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} + "updateTime": "A String", # Output only. The time when the Entry Link was last updated. +}
+
+ +
+ patch(name, allowMissing=None, aspectKeys=None, body=None, x__xgafv=None) +
Updates an Entry Link.
+
+Args:
+  name: string, Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # EntryLink represents a link between two Entries.
+  "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed.
+    "a_key": { # An aspect is a single piece of metadata describing an entry.
+      "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+        "createTime": "A String", # The time the aspect was created in the source system.
+        "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
+        "updateTime": "A String", # The time the aspect was last updated in the source system.
+      },
+      "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
+      "createTime": "A String", # Output only. The time when the Aspect was created.
+      "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
+        "a_key": "", # Properties of the object.
+      },
+      "path": "A String", # Output only. The path in the entry under which the aspect is attached.
+      "updateTime": "A String", # Output only. The time when the Aspect was last updated.
+    },
+  },
+  "createTime": "A String", # Output only. The time when the Entry Link was created.
+  "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition
+  "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references.
+    { # Reference to the Entry that is linked through the Entry Link.
+      "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}
+      "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link.
+      "type": "A String", # Required. Immutable. The reference type of the Entry.
+    },
+  ],
+  "name": "A String", # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}
+  "updateTime": "A String", # Output only. The time when the Entry Link was last updated.
+}
+
+  allowMissing: boolean, Optional. If set to true and the entry link doesn't exist, the service will create it.
+  aspectKeys: string, Optional. The map keys of the Aspects which the service should modify. It should be the aspect type reference in the format {project_id_or_number}.{location_id}.{aspect_type_id}.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request. (repeated)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # EntryLink represents a link between two Entries.
+  "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed.
+    "a_key": { # An aspect is a single piece of metadata describing an entry.
+      "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+        "createTime": "A String", # The time the aspect was created in the source system.
+        "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
+        "updateTime": "A String", # The time the aspect was last updated in the source system.
+      },
+      "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
+      "createTime": "A String", # Output only. The time when the Aspect was created.
+      "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
+        "a_key": "", # Properties of the object.
+      },
+      "path": "A String", # Output only. The path in the entry under which the aspect is attached.
+      "updateTime": "A String", # Output only. The time when the Aspect was last updated.
+    },
+  },
   "createTime": "A String", # Output only. The time when the Entry Link was created.
   "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition
-  "entryReferences": [ # Required. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references.
+  "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references.
     { # Reference to the Entry that is linked through the Entry Link.
       "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}
       "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link.
diff --git a/docs/dyn/dataplex_v1.projects.locations.html b/docs/dyn/dataplex_v1.projects.locations.html
index 92448e990d..68f7dc300c 100644
--- a/docs/dyn/dataplex_v1.projects.locations.html
+++ b/docs/dyn/dataplex_v1.projects.locations.html
@@ -359,9 +359,25 @@ 

Method Details

{ # Response message for LookupEntryLinks. "entryLinks": [ # List of entry links that reference the specified entry. { # EntryLink represents a link between two Entries. + "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed. + "a_key": { # An aspect is a single piece of metadata describing an entry. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc). + "updateTime": "A String", # The time the aspect was last updated in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, "createTime": "A String", # Output only. The time when the Entry Link was created. "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition - "entryReferences": [ # Required. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references. + "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references. { # Reference to the Entry that is linked through the Entry Link. "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link. diff --git a/googleapiclient/discovery_cache/documents/dataplex.v1.json b/googleapiclient/discovery_cache/documents/dataplex.v1.json index 5a534eed2a..980e3cc13b 100644 --- a/googleapiclient/discovery_cache/documents/dataplex.v1.json +++ b/googleapiclient/discovery_cache/documents/dataplex.v1.json @@ -3666,6 +3666,45 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"patch": { +"description": "Updates an Entry Link.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entryLinks/{entryLinksId}", +"httpMethod": "PATCH", +"id": "dataplex.projects.locations.entryGroups.entryLinks.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"allowMissing": { +"description": "Optional. If set to true and the entry link doesn't exist, the service will create it.", +"location": "query", +"type": "boolean" +}, +"aspectKeys": { +"description": "Optional. The map keys of the Aspects which the service should modify. It should be the aspect type reference in the format {project_id_or_number}.{location_id}.{aspect_type_id}.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request.", +"location": "query", +"repeated": true, +"type": "string" +}, +"name": { +"description": "Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entryLinks/.*$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "GoogleCloudDataplexV1EntryLink" +}, +"response": { +"$ref": "GoogleCloudDataplexV1EntryLink" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } } } @@ -7931,7 +7970,7 @@ } } }, -"revision": "20260213", +"revision": "20260227", "rootUrl": "https://dataplex.googleapis.com/", "schemas": { "Empty": { @@ -11901,6 +11940,13 @@ "description": "EntryLink represents a link between two Entries.", "id": "GoogleCloudDataplexV1EntryLink", "properties": { +"aspects": { +"additionalProperties": { +"$ref": "GoogleCloudDataplexV1Aspect" +}, +"description": "Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed.", +"type": "object" +}, "createTime": { "description": "Output only. The time when the Entry Link was created.", "format": "google-datetime", @@ -11912,7 +11958,7 @@ "type": "string" }, "entryReferences": { -"description": "Required. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references.", +"description": "Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references.", "items": { "$ref": "GoogleCloudDataplexV1EntryLinkEntryReference" }, From bf7598a36a8138c5a7ca58b8a0ac0e898d2d0955 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 10 Mar 2026 07:24:05 +0000 Subject: [PATCH 12/31] feat(discoveryengine): update the api #### discoveryengine:v1 The following keys were added: - schemas.GoogleCloudDiscoveryengineV1ActionConfig.properties.userDefinedScopesMapping (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1ActionConfigScopeList (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1AnswerReference.properties.queries (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1DataStore.properties.federatedSearchConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfig (Total Keys: 29) - schemas.GoogleCloudDiscoveryengineV1UserEvent.properties.entity.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaActionConfig.properties.userDefinedScopesMapping (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaActionConfigScopeList (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1alphaAnswerReference.properties.queries (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.federatedSearchConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfig (Total Keys: 29) - schemas.GoogleCloudDiscoveryengineV1betaDataStore.properties.federatedSearchConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfig (Total Keys: 29) #### discoveryengine:v1alpha The following keys were added: - schemas.GoogleCloudDiscoveryengineV1ActionConfig.properties.userDefinedScopesMapping (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1ActionConfigScopeList (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1DataStore.properties.federatedSearchConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfig (Total Keys: 29) - schemas.GoogleCloudDiscoveryengineV1alphaActionConfig.properties.userDefinedScopesMapping (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaActionConfigScopeList (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1alphaAnswerReference.properties.queries (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.federatedSearchConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfig (Total Keys: 29) - schemas.GoogleCloudDiscoveryengineV1alphaUserEvent.properties.entity.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaDataStore.properties.federatedSearchConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfig (Total Keys: 29) #### discoveryengine:v1beta The following keys were added: - schemas.GoogleCloudDiscoveryengineV1ActionConfig.properties.userDefinedScopesMapping (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1ActionConfigScopeList (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1DataStore.properties.federatedSearchConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfig (Total Keys: 29) - schemas.GoogleCloudDiscoveryengineV1alphaActionConfig.properties.userDefinedScopesMapping (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaActionConfigScopeList (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1alphaAnswerReference.properties.queries (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.federatedSearchConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfig (Total Keys: 29) - schemas.GoogleCloudDiscoveryengineV1betaAnswerReference.properties.queries (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1betaDataStore.properties.federatedSearchConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfig (Total Keys: 29) - schemas.GoogleCloudDiscoveryengineV1betaUserEvent.properties.entity.type (Total Keys: 1) --- ...llections.dataStores.completionConfig.html | 2 +- ...ects.locations.collections.dataStores.html | 125 +++++ ...collections.dataStores.servingConfigs.html | 27 +- ...llections.dataStores.sessions.answers.html | 3 + ...tions.collections.dataStores.sessions.html | 18 + ...ons.collections.dataStores.userEvents.html | 9 +- ....collections.engines.completionConfig.html | 2 +- ...ns.collections.engines.servingConfigs.html | 27 +- ....collections.engines.sessions.answers.html | 3 + ...ocations.collections.engines.sessions.html | 18 + ...ine_v1.projects.locations.collections.html | 27 +- ...locations.dataStores.completionConfig.html | 2 +- ...gine_v1.projects.locations.dataStores.html | 125 +++++ ...s.locations.dataStores.servingConfigs.html | 27 +- ...locations.dataStores.sessions.answers.html | 3 + ...rojects.locations.dataStores.sessions.html | 18 + ...jects.locations.dataStores.userEvents.html | 9 +- ...discoveryengine_v1.projects.locations.html | 18 +- ...gine_v1.projects.locations.userEvents.html | 9 +- ...llections.dataStores.completionConfig.html | 2 +- ...ects.locations.collections.dataStores.html | 125 +++++ ...collections.dataStores.servingConfigs.html | 27 +- ...llections.dataStores.sessions.answers.html | 3 + ...tions.collections.dataStores.sessions.html | 18 + ...ons.collections.dataStores.userEvents.html | 9 +- ....collections.engines.completionConfig.html | 4 +- ...ns.collections.engines.servingConfigs.html | 27 +- ....collections.engines.sessions.answers.html | 3 + ...ocations.collections.engines.sessions.html | 18 + ...1alpha.projects.locations.collections.html | 54 ++- ...locations.dataStores.completionConfig.html | 2 +- ...v1alpha.projects.locations.dataStores.html | 125 +++++ ...s.locations.dataStores.servingConfigs.html | 27 +- ...locations.dataStores.sessions.answers.html | 3 + ...rojects.locations.dataStores.sessions.html | 18 + ...jects.locations.dataStores.userEvents.html | 9 +- ...1alpha.projects.locations.evaluations.html | 18 +- ...veryengine_v1alpha.projects.locations.html | 18 +- ...v1alpha.projects.locations.userEvents.html | 9 +- ...llections.dataStores.completionConfig.html | 2 +- ...ects.locations.collections.dataStores.html | 125 +++++ ...collections.dataStores.servingConfigs.html | 27 +- ...llections.dataStores.sessions.answers.html | 3 + ...tions.collections.dataStores.sessions.html | 18 + ...ons.collections.dataStores.userEvents.html | 9 +- ....collections.engines.completionConfig.html | 4 +- ...ns.collections.engines.servingConfigs.html | 27 +- ....collections.engines.sessions.answers.html | 3 + ...ocations.collections.engines.sessions.html | 18 + ...locations.dataStores.completionConfig.html | 2 +- ..._v1beta.projects.locations.dataStores.html | 125 +++++ ...s.locations.dataStores.servingConfigs.html | 27 +- ...locations.dataStores.sessions.answers.html | 3 + ...rojects.locations.dataStores.sessions.html | 18 + ...jects.locations.dataStores.userEvents.html | 9 +- ...v1beta.projects.locations.evaluations.html | 18 +- ..._v1beta.projects.locations.userEvents.html | 9 +- .../documents/discoveryengine.v1.json | 455 +++++++++++++++++- .../documents/discoveryengine.v1alpha.json | 441 ++++++++++++++++- .../documents/discoveryengine.v1beta.json | 449 ++++++++++++++++- 60 files changed, 2621 insertions(+), 162 deletions(-) diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.completionConfig.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.completionConfig.html index 581e1584f8..9f0cd5e719 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.completionConfig.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.completionConfig.html @@ -122,7 +122,7 @@

Method Details

"userInfo": { # Information of an end user. # Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 } diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html index 36652df182..7cef2261ed 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html @@ -326,6 +326,31 @@

Method Details

}, }, }, + "federatedSearchConfig": { # Stores information for federated search. # Optional. If set, this DataStore is a federated search DataStore. + "alloyDbConfig": { # Stores information for connecting to AlloyDB. # AlloyDB config. If set, this DataStore is connected to AlloyDB. + "alloydbAiNlConfig": { # Configuration for AlloyDB AI Natural Language. # Optional. Configuration for Magic. + "nlConfigId": "A String", # Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty. + }, + "alloydbConnectionConfig": { # Configuration for connecting to AlloyDB. # Required. Configuration for connecting to AlloyDB. + "authMode": "A String", # Optional. Auth mode. + "database": "A String", # Required. The AlloyDB database to connect to. + "enablePsvs": True or False, # Optional. If true, enable PSVS for AlloyDB. + "instance": "A String", # Required. The AlloyDB instance to connect to. + "password": "A String", # Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user. + "user": "A String", # Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user. + }, + "returnedFields": [ # Optional. Fields to be returned in the search results. If empty, all fields will be returned. + "A String", + ], + }, + "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* + }, + "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. + "appName": "A String", # Optional. The type of the application. E.g., "jira", "box", etc. + "instanceName": "A String", # Optional. The instance name identifying the 3P app, e.g., "vaissptbots-my". This is different from the instance_uri which is the full URL of the 3P app e.g., "https://vaissptbots-my.sharepoint.com". + }, + }, "healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. @@ -546,6 +571,31 @@

Method Details

}, }, }, + "federatedSearchConfig": { # Stores information for federated search. # Optional. If set, this DataStore is a federated search DataStore. + "alloyDbConfig": { # Stores information for connecting to AlloyDB. # AlloyDB config. If set, this DataStore is connected to AlloyDB. + "alloydbAiNlConfig": { # Configuration for AlloyDB AI Natural Language. # Optional. Configuration for Magic. + "nlConfigId": "A String", # Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty. + }, + "alloydbConnectionConfig": { # Configuration for connecting to AlloyDB. # Required. Configuration for connecting to AlloyDB. + "authMode": "A String", # Optional. Auth mode. + "database": "A String", # Required. The AlloyDB database to connect to. + "enablePsvs": True or False, # Optional. If true, enable PSVS for AlloyDB. + "instance": "A String", # Required. The AlloyDB instance to connect to. + "password": "A String", # Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user. + "user": "A String", # Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user. + }, + "returnedFields": [ # Optional. Fields to be returned in the search results. If empty, all fields will be returned. + "A String", + ], + }, + "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* + }, + "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. + "appName": "A String", # Optional. The type of the application. E.g., "jira", "box", etc. + "instanceName": "A String", # Optional. The instance name identifying the 3P app, e.g., "vaissptbots-my". This is different from the instance_uri which is the full URL of the 3P app e.g., "https://vaissptbots-my.sharepoint.com". + }, + }, "healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. @@ -722,6 +772,31 @@

Method Details

}, }, }, + "federatedSearchConfig": { # Stores information for federated search. # Optional. If set, this DataStore is a federated search DataStore. + "alloyDbConfig": { # Stores information for connecting to AlloyDB. # AlloyDB config. If set, this DataStore is connected to AlloyDB. + "alloydbAiNlConfig": { # Configuration for AlloyDB AI Natural Language. # Optional. Configuration for Magic. + "nlConfigId": "A String", # Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty. + }, + "alloydbConnectionConfig": { # Configuration for connecting to AlloyDB. # Required. Configuration for connecting to AlloyDB. + "authMode": "A String", # Optional. Auth mode. + "database": "A String", # Required. The AlloyDB database to connect to. + "enablePsvs": True or False, # Optional. If true, enable PSVS for AlloyDB. + "instance": "A String", # Required. The AlloyDB instance to connect to. + "password": "A String", # Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user. + "user": "A String", # Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user. + }, + "returnedFields": [ # Optional. Fields to be returned in the search results. If empty, all fields will be returned. + "A String", + ], + }, + "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* + }, + "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. + "appName": "A String", # Optional. The type of the application. E.g., "jira", "box", etc. + "instanceName": "A String", # Optional. The instance name identifying the 3P app, e.g., "vaissptbots-my". This is different from the instance_uri which is the full URL of the 3P app e.g., "https://vaissptbots-my.sharepoint.com". + }, + }, "healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. @@ -886,6 +961,31 @@

Method Details

}, }, }, + "federatedSearchConfig": { # Stores information for federated search. # Optional. If set, this DataStore is a federated search DataStore. + "alloyDbConfig": { # Stores information for connecting to AlloyDB. # AlloyDB config. If set, this DataStore is connected to AlloyDB. + "alloydbAiNlConfig": { # Configuration for AlloyDB AI Natural Language. # Optional. Configuration for Magic. + "nlConfigId": "A String", # Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty. + }, + "alloydbConnectionConfig": { # Configuration for connecting to AlloyDB. # Required. Configuration for connecting to AlloyDB. + "authMode": "A String", # Optional. Auth mode. + "database": "A String", # Required. The AlloyDB database to connect to. + "enablePsvs": True or False, # Optional. If true, enable PSVS for AlloyDB. + "instance": "A String", # Required. The AlloyDB instance to connect to. + "password": "A String", # Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user. + "user": "A String", # Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user. + }, + "returnedFields": [ # Optional. Fields to be returned in the search results. If empty, all fields will be returned. + "A String", + ], + }, + "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* + }, + "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. + "appName": "A String", # Optional. The type of the application. E.g., "jira", "box", etc. + "instanceName": "A String", # Optional. The instance name identifying the 3P app, e.g., "vaissptbots-my". This is different from the instance_uri which is the full URL of the 3P app e.g., "https://vaissptbots-my.sharepoint.com". + }, + }, "healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. @@ -1032,6 +1132,31 @@

Method Details

}, }, }, + "federatedSearchConfig": { # Stores information for federated search. # Optional. If set, this DataStore is a federated search DataStore. + "alloyDbConfig": { # Stores information for connecting to AlloyDB. # AlloyDB config. If set, this DataStore is connected to AlloyDB. + "alloydbAiNlConfig": { # Configuration for AlloyDB AI Natural Language. # Optional. Configuration for Magic. + "nlConfigId": "A String", # Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty. + }, + "alloydbConnectionConfig": { # Configuration for connecting to AlloyDB. # Required. Configuration for connecting to AlloyDB. + "authMode": "A String", # Optional. Auth mode. + "database": "A String", # Required. The AlloyDB database to connect to. + "enablePsvs": True or False, # Optional. If true, enable PSVS for AlloyDB. + "instance": "A String", # Required. The AlloyDB instance to connect to. + "password": "A String", # Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user. + "user": "A String", # Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user. + }, + "returnedFields": [ # Optional. Fields to be returned in the search results. If empty, all fields will be returned. + "A String", + ], + }, + "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* + }, + "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. + "appName": "A String", # Optional. The type of the application. E.g., "jira", "box", etc. + "instanceName": "A String", # Optional. The instance name identifying the 3P app, e.g., "vaissptbots-my". This is different from the instance_uri which is the full URL of the 3P app e.g., "https://vaissptbots-my.sharepoint.com". + }, + }, "healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. 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 3d1b885996..fac8b4a099 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html @@ -352,6 +352,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -502,6 +505,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -1418,6 +1424,7 @@

Method Details

}, ], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. + "entity": "A String", # Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -1494,7 +1501,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. }, @@ -1751,8 +1758,8 @@

Method Details

"searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. - "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. + "sessionSpec": { # Session specification. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, @@ -1762,7 +1769,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. "a_key": "A String", @@ -2202,8 +2209,8 @@

Method Details

"searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. - "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. + "sessionSpec": { # Session specification. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, @@ -2213,7 +2220,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. "a_key": "A String", @@ -2742,6 +2749,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -2892,6 +2902,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.answers.html index 1314f939cc..115c1646b6 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.answers.html @@ -157,6 +157,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. 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 f23cb0db42..db4610270a 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.html @@ -185,6 +185,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -453,6 +456,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -747,6 +753,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -1029,6 +1038,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -1315,6 +1327,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -1584,6 +1599,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.userEvents.html index 07b667f626..24f74a3f37 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.userEvents.html @@ -189,6 +189,7 @@

Method Details

}, ], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. + "entity": "A String", # Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -265,7 +266,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. }, @@ -387,6 +388,7 @@

Method Details

}, ], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. + "entity": "A String", # Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -463,7 +465,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. } @@ -510,6 +512,7 @@

Method Details

}, ], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. + "entity": "A String", # Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -586,7 +589,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. }
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.completionConfig.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.completionConfig.html index 4bed59e12e..ce9a4ab196 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.completionConfig.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.completionConfig.html @@ -122,7 +122,7 @@

Method Details

"userInfo": { # Information of an end user. # Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 } 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 639ffc52f5..b66d3881a7 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html @@ -352,6 +352,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -502,6 +505,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -1418,6 +1424,7 @@

Method Details

}, ], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. + "entity": "A String", # Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -1494,7 +1501,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. }, @@ -1751,8 +1758,8 @@

Method Details

"searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. - "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. + "sessionSpec": { # Session specification. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, @@ -1762,7 +1769,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. "a_key": "A String", @@ -2202,8 +2209,8 @@

Method Details

"searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. - "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. + "sessionSpec": { # Session specification. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, @@ -2213,7 +2220,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. "a_key": "A String", @@ -2742,6 +2749,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -2892,6 +2902,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.answers.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.answers.html index 040675c0a1..b9109946bf 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.answers.html @@ -157,6 +157,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. 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 d9ea70d05e..66211a540f 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.html @@ -185,6 +185,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -453,6 +456,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -747,6 +753,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -1029,6 +1038,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -1315,6 +1327,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -1584,6 +1599,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.html index d2de23f459..a586a81b19 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.html @@ -171,6 +171,13 @@

Method Details

"jsonActionParams": "A String", # Optional. Action parameters in json string format. "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. "useStaticSecrets": True or False, # Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored. + "userDefinedScopesMapping": { # Optional. Mapping from operation name to the list of scopes. Only be populated if there are user specified scopes. + "a_key": { # Stores a list of scopes. + "scopes": [ # Optional. The list of scopes. + "A String", + ], + }, + }, }, "actionState": "A String", # Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors. "alertPolicyConfigs": [ # Optional. The connector level alert config. @@ -202,7 +209,7 @@

Method Details

"connectorType": "A String", # Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system. "createEuaSaas": True or False, # Optional. Whether the END USER AUTHENTICATION connector is created in SaaS. "createTime": "A String", # Output only. Timestamp the DataConnector was created at. - "dataSource": "A String", # Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`. + "dataSource": "A String", # Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk` "destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services. { # Defines target endpoints used to connect to third-party sources. "destinations": [ # Optional. The destinations for the corresponding key. @@ -377,6 +384,13 @@

Method Details

"jsonActionParams": "A String", # Optional. Action parameters in json string format. "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. "useStaticSecrets": True or False, # Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored. + "userDefinedScopesMapping": { # Optional. Mapping from operation name to the list of scopes. Only be populated if there are user specified scopes. + "a_key": { # Stores a list of scopes. + "scopes": [ # Optional. The list of scopes. + "A String", + ], + }, + }, }, "actionState": "A String", # Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors. "alertPolicyConfigs": [ # Optional. The connector level alert config. @@ -408,7 +422,7 @@

Method Details

"connectorType": "A String", # Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system. "createEuaSaas": True or False, # Optional. Whether the END USER AUTHENTICATION connector is created in SaaS. "createTime": "A String", # Output only. Timestamp the DataConnector was created at. - "dataSource": "A String", # Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`. + "dataSource": "A String", # Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk` "destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services. { # Defines target endpoints used to connect to third-party sources. "destinations": [ # Optional. The destinations for the corresponding key. @@ -582,6 +596,13 @@

Method Details

"jsonActionParams": "A String", # Optional. Action parameters in json string format. "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. "useStaticSecrets": True or False, # Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored. + "userDefinedScopesMapping": { # Optional. Mapping from operation name to the list of scopes. Only be populated if there are user specified scopes. + "a_key": { # Stores a list of scopes. + "scopes": [ # Optional. The list of scopes. + "A String", + ], + }, + }, }, "actionState": "A String", # Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors. "alertPolicyConfigs": [ # Optional. The connector level alert config. @@ -613,7 +634,7 @@

Method Details

"connectorType": "A String", # Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system. "createEuaSaas": True or False, # Optional. Whether the END USER AUTHENTICATION connector is created in SaaS. "createTime": "A String", # Output only. Timestamp the DataConnector was created at. - "dataSource": "A String", # Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`. + "dataSource": "A String", # Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk` "destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services. { # Defines target endpoints used to connect to third-party sources. "destinations": [ # Optional. The destinations for the corresponding key. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.completionConfig.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.completionConfig.html index 930a7f0b8c..8828632d14 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.completionConfig.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.completionConfig.html @@ -122,7 +122,7 @@

Method Details

"userInfo": { # Information of an end user. # Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 } diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html index 5d5fd07792..8977ac4a3e 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html @@ -318,6 +318,31 @@

Method Details

}, }, }, + "federatedSearchConfig": { # Stores information for federated search. # Optional. If set, this DataStore is a federated search DataStore. + "alloyDbConfig": { # Stores information for connecting to AlloyDB. # AlloyDB config. If set, this DataStore is connected to AlloyDB. + "alloydbAiNlConfig": { # Configuration for AlloyDB AI Natural Language. # Optional. Configuration for Magic. + "nlConfigId": "A String", # Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty. + }, + "alloydbConnectionConfig": { # Configuration for connecting to AlloyDB. # Required. Configuration for connecting to AlloyDB. + "authMode": "A String", # Optional. Auth mode. + "database": "A String", # Required. The AlloyDB database to connect to. + "enablePsvs": True or False, # Optional. If true, enable PSVS for AlloyDB. + "instance": "A String", # Required. The AlloyDB instance to connect to. + "password": "A String", # Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user. + "user": "A String", # Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user. + }, + "returnedFields": [ # Optional. Fields to be returned in the search results. If empty, all fields will be returned. + "A String", + ], + }, + "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* + }, + "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. + "appName": "A String", # Optional. The type of the application. E.g., "jira", "box", etc. + "instanceName": "A String", # Optional. The instance name identifying the 3P app, e.g., "vaissptbots-my". This is different from the instance_uri which is the full URL of the 3P app e.g., "https://vaissptbots-my.sharepoint.com". + }, + }, "healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. @@ -538,6 +563,31 @@

Method Details

}, }, }, + "federatedSearchConfig": { # Stores information for federated search. # Optional. If set, this DataStore is a federated search DataStore. + "alloyDbConfig": { # Stores information for connecting to AlloyDB. # AlloyDB config. If set, this DataStore is connected to AlloyDB. + "alloydbAiNlConfig": { # Configuration for AlloyDB AI Natural Language. # Optional. Configuration for Magic. + "nlConfigId": "A String", # Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty. + }, + "alloydbConnectionConfig": { # Configuration for connecting to AlloyDB. # Required. Configuration for connecting to AlloyDB. + "authMode": "A String", # Optional. Auth mode. + "database": "A String", # Required. The AlloyDB database to connect to. + "enablePsvs": True or False, # Optional. If true, enable PSVS for AlloyDB. + "instance": "A String", # Required. The AlloyDB instance to connect to. + "password": "A String", # Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user. + "user": "A String", # Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user. + }, + "returnedFields": [ # Optional. Fields to be returned in the search results. If empty, all fields will be returned. + "A String", + ], + }, + "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* + }, + "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. + "appName": "A String", # Optional. The type of the application. E.g., "jira", "box", etc. + "instanceName": "A String", # Optional. The instance name identifying the 3P app, e.g., "vaissptbots-my". This is different from the instance_uri which is the full URL of the 3P app e.g., "https://vaissptbots-my.sharepoint.com". + }, + }, "healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. @@ -714,6 +764,31 @@

Method Details

}, }, }, + "federatedSearchConfig": { # Stores information for federated search. # Optional. If set, this DataStore is a federated search DataStore. + "alloyDbConfig": { # Stores information for connecting to AlloyDB. # AlloyDB config. If set, this DataStore is connected to AlloyDB. + "alloydbAiNlConfig": { # Configuration for AlloyDB AI Natural Language. # Optional. Configuration for Magic. + "nlConfigId": "A String", # Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty. + }, + "alloydbConnectionConfig": { # Configuration for connecting to AlloyDB. # Required. Configuration for connecting to AlloyDB. + "authMode": "A String", # Optional. Auth mode. + "database": "A String", # Required. The AlloyDB database to connect to. + "enablePsvs": True or False, # Optional. If true, enable PSVS for AlloyDB. + "instance": "A String", # Required. The AlloyDB instance to connect to. + "password": "A String", # Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user. + "user": "A String", # Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user. + }, + "returnedFields": [ # Optional. Fields to be returned in the search results. If empty, all fields will be returned. + "A String", + ], + }, + "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* + }, + "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. + "appName": "A String", # Optional. The type of the application. E.g., "jira", "box", etc. + "instanceName": "A String", # Optional. The instance name identifying the 3P app, e.g., "vaissptbots-my". This is different from the instance_uri which is the full URL of the 3P app e.g., "https://vaissptbots-my.sharepoint.com". + }, + }, "healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. @@ -878,6 +953,31 @@

Method Details

}, }, }, + "federatedSearchConfig": { # Stores information for federated search. # Optional. If set, this DataStore is a federated search DataStore. + "alloyDbConfig": { # Stores information for connecting to AlloyDB. # AlloyDB config. If set, this DataStore is connected to AlloyDB. + "alloydbAiNlConfig": { # Configuration for AlloyDB AI Natural Language. # Optional. Configuration for Magic. + "nlConfigId": "A String", # Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty. + }, + "alloydbConnectionConfig": { # Configuration for connecting to AlloyDB. # Required. Configuration for connecting to AlloyDB. + "authMode": "A String", # Optional. Auth mode. + "database": "A String", # Required. The AlloyDB database to connect to. + "enablePsvs": True or False, # Optional. If true, enable PSVS for AlloyDB. + "instance": "A String", # Required. The AlloyDB instance to connect to. + "password": "A String", # Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user. + "user": "A String", # Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user. + }, + "returnedFields": [ # Optional. Fields to be returned in the search results. If empty, all fields will be returned. + "A String", + ], + }, + "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* + }, + "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. + "appName": "A String", # Optional. The type of the application. E.g., "jira", "box", etc. + "instanceName": "A String", # Optional. The instance name identifying the 3P app, e.g., "vaissptbots-my". This is different from the instance_uri which is the full URL of the 3P app e.g., "https://vaissptbots-my.sharepoint.com". + }, + }, "healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. @@ -1024,6 +1124,31 @@

Method Details

}, }, }, + "federatedSearchConfig": { # Stores information for federated search. # Optional. If set, this DataStore is a federated search DataStore. + "alloyDbConfig": { # Stores information for connecting to AlloyDB. # AlloyDB config. If set, this DataStore is connected to AlloyDB. + "alloydbAiNlConfig": { # Configuration for AlloyDB AI Natural Language. # Optional. Configuration for Magic. + "nlConfigId": "A String", # Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty. + }, + "alloydbConnectionConfig": { # Configuration for connecting to AlloyDB. # Required. Configuration for connecting to AlloyDB. + "authMode": "A String", # Optional. Auth mode. + "database": "A String", # Required. The AlloyDB database to connect to. + "enablePsvs": True or False, # Optional. If true, enable PSVS for AlloyDB. + "instance": "A String", # Required. The AlloyDB instance to connect to. + "password": "A String", # Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user. + "user": "A String", # Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user. + }, + "returnedFields": [ # Optional. Fields to be returned in the search results. If empty, all fields will be returned. + "A String", + ], + }, + "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* + }, + "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. + "appName": "A String", # Optional. The type of the application. E.g., "jira", "box", etc. + "instanceName": "A String", # Optional. The instance name identifying the 3P app, e.g., "vaissptbots-my". This is different from the instance_uri which is the full URL of the 3P app e.g., "https://vaissptbots-my.sharepoint.com". + }, + }, "healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html index 8c2b117f8f..a2654650d9 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html @@ -352,6 +352,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -502,6 +505,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -1418,6 +1424,7 @@

Method Details

}, ], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. + "entity": "A String", # Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -1494,7 +1501,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. }, @@ -1751,8 +1758,8 @@

Method Details

"searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. - "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. + "sessionSpec": { # Session specification. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, @@ -1762,7 +1769,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. "a_key": "A String", @@ -2202,8 +2209,8 @@

Method Details

"searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. - "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. + "sessionSpec": { # Session specification. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, @@ -2213,7 +2220,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. "a_key": "A String", @@ -2742,6 +2749,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -2892,6 +2902,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.answers.html index 8b9e07fb92..b62961574d 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.answers.html @@ -157,6 +157,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.html index 010b2d499d..87d91d2dbe 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.html @@ -185,6 +185,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -453,6 +456,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -747,6 +753,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -1029,6 +1038,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -1315,6 +1327,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -1584,6 +1599,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.userEvents.html index 54c8800d0f..d96d21615c 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.userEvents.html @@ -189,6 +189,7 @@

Method Details

}, ], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. + "entity": "A String", # Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -265,7 +266,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. }, @@ -387,6 +388,7 @@

Method Details

}, ], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. + "entity": "A String", # Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -463,7 +465,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. } @@ -510,6 +512,7 @@

Method Details

}, ], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. + "entity": "A String", # Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -586,7 +589,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. }
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.html b/docs/dyn/discoveryengine_v1.projects.locations.html index 47bffa7206..59cf2d5368 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.html @@ -233,6 +233,13 @@

Method Details

"jsonActionParams": "A String", # Optional. Action parameters in json string format. "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. "useStaticSecrets": True or False, # Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored. + "userDefinedScopesMapping": { # Optional. Mapping from operation name to the list of scopes. Only be populated if there are user specified scopes. + "a_key": { # Stores a list of scopes. + "scopes": [ # Optional. The list of scopes. + "A String", + ], + }, + }, }, "actionState": "A String", # Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors. "alertPolicyConfigs": [ # Optional. The connector level alert config. @@ -264,7 +271,7 @@

Method Details

"connectorType": "A String", # Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system. "createEuaSaas": True or False, # Optional. Whether the END USER AUTHENTICATION connector is created in SaaS. "createTime": "A String", # Output only. Timestamp the DataConnector was created at. - "dataSource": "A String", # Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`. + "dataSource": "A String", # Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk` "destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services. { # Defines target endpoints used to connect to third-party sources. "destinations": [ # Optional. The destinations for the corresponding key. @@ -468,6 +475,13 @@

Method Details

"jsonActionParams": "A String", # Optional. Action parameters in json string format. "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. "useStaticSecrets": True or False, # Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored. + "userDefinedScopesMapping": { # Optional. Mapping from operation name to the list of scopes. Only be populated if there are user specified scopes. + "a_key": { # Stores a list of scopes. + "scopes": [ # Optional. The list of scopes. + "A String", + ], + }, + }, }, "actionState": "A String", # Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors. "alertPolicyConfigs": [ # Optional. The connector level alert config. @@ -499,7 +513,7 @@

Method Details

"connectorType": "A String", # Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system. "createEuaSaas": True or False, # Optional. Whether the END USER AUTHENTICATION connector is created in SaaS. "createTime": "A String", # Output only. Timestamp the DataConnector was created at. - "dataSource": "A String", # Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`. + "dataSource": "A String", # Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk` "destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services. { # Defines target endpoints used to connect to third-party sources. "destinations": [ # Optional. The destinations for the corresponding key. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.userEvents.html b/docs/dyn/discoveryengine_v1.projects.locations.userEvents.html index c0641c4a93..87eb4a2c73 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.userEvents.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.userEvents.html @@ -186,6 +186,7 @@

Method Details

}, ], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. + "entity": "A String", # Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -262,7 +263,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. }, @@ -341,6 +342,7 @@

Method Details

}, ], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. + "entity": "A String", # Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -417,7 +419,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. } @@ -464,6 +466,7 @@

Method Details

}, ], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. + "entity": "A String", # Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -540,7 +543,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. }
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.completionConfig.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.completionConfig.html index 13d36d1065..c0fe218244 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.completionConfig.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.completionConfig.html @@ -122,7 +122,7 @@

Method Details

"userInfo": { # Information of an end user. # Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 } diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html index 1c6a354259..f30f81b39f 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html @@ -389,6 +389,31 @@

Method Details

}, }, }, + "federatedSearchConfig": { # Stores information for federated search. # Optional. If set, this DataStore is a federated search DataStore. + "alloyDbConfig": { # Stores information for connecting to AlloyDB. # AlloyDB config. If set, this DataStore is connected to AlloyDB. + "alloydbAiNlConfig": { # Configuration for AlloyDB AI Natural Language. # Optional. Configuration for Magic. + "nlConfigId": "A String", # Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty. + }, + "alloydbConnectionConfig": { # Configuration for connecting to AlloyDB. # Required. Configuration for connecting to AlloyDB. + "authMode": "A String", # Optional. Auth mode. + "database": "A String", # Required. The AlloyDB database to connect to. + "enablePsvs": True or False, # Optional. If true, enable PSVS for AlloyDB. + "instance": "A String", # Required. The AlloyDB instance to connect to. + "password": "A String", # Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user. + "user": "A String", # Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user. + }, + "returnedFields": [ # Optional. Fields to be returned in the search results. If empty, all fields will be returned. + "A String", + ], + }, + "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* + }, + "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. + "appName": "A String", # Optional. The type of the application. E.g., "jira", "box", etc. + "instanceName": "A String", # Optional. The instance name identifying the 3P app, e.g., "vaissptbots-my". This is different from the instance_uri which is the full URL of the 3P app e.g., "https://vaissptbots-my.sharepoint.com". + }, + }, "healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. @@ -683,6 +708,31 @@

Method Details

}, }, }, + "federatedSearchConfig": { # Stores information for federated search. # Optional. If set, this DataStore is a federated search DataStore. + "alloyDbConfig": { # Stores information for connecting to AlloyDB. # AlloyDB config. If set, this DataStore is connected to AlloyDB. + "alloydbAiNlConfig": { # Configuration for AlloyDB AI Natural Language. # Optional. Configuration for Magic. + "nlConfigId": "A String", # Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty. + }, + "alloydbConnectionConfig": { # Configuration for connecting to AlloyDB. # Required. Configuration for connecting to AlloyDB. + "authMode": "A String", # Optional. Auth mode. + "database": "A String", # Required. The AlloyDB database to connect to. + "enablePsvs": True or False, # Optional. If true, enable PSVS for AlloyDB. + "instance": "A String", # Required. The AlloyDB instance to connect to. + "password": "A String", # Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user. + "user": "A String", # Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user. + }, + "returnedFields": [ # Optional. Fields to be returned in the search results. If empty, all fields will be returned. + "A String", + ], + }, + "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* + }, + "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. + "appName": "A String", # Optional. The type of the application. E.g., "jira", "box", etc. + "instanceName": "A String", # Optional. The instance name identifying the 3P app, e.g., "vaissptbots-my". This is different from the instance_uri which is the full URL of the 3P app e.g., "https://vaissptbots-my.sharepoint.com". + }, + }, "healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. @@ -974,6 +1024,31 @@

Method Details

}, }, }, + "federatedSearchConfig": { # Stores information for federated search. # Optional. If set, this DataStore is a federated search DataStore. + "alloyDbConfig": { # Stores information for connecting to AlloyDB. # AlloyDB config. If set, this DataStore is connected to AlloyDB. + "alloydbAiNlConfig": { # Configuration for AlloyDB AI Natural Language. # Optional. Configuration for Magic. + "nlConfigId": "A String", # Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty. + }, + "alloydbConnectionConfig": { # Configuration for connecting to AlloyDB. # Required. Configuration for connecting to AlloyDB. + "authMode": "A String", # Optional. Auth mode. + "database": "A String", # Required. The AlloyDB database to connect to. + "enablePsvs": True or False, # Optional. If true, enable PSVS for AlloyDB. + "instance": "A String", # Required. The AlloyDB instance to connect to. + "password": "A String", # Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user. + "user": "A String", # Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user. + }, + "returnedFields": [ # Optional. Fields to be returned in the search results. If empty, all fields will be returned. + "A String", + ], + }, + "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* + }, + "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. + "appName": "A String", # Optional. The type of the application. E.g., "jira", "box", etc. + "instanceName": "A String", # Optional. The instance name identifying the 3P app, e.g., "vaissptbots-my". This is different from the instance_uri which is the full URL of the 3P app e.g., "https://vaissptbots-my.sharepoint.com". + }, + }, "healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. @@ -1170,6 +1245,31 @@

Method Details

}, }, }, + "federatedSearchConfig": { # Stores information for federated search. # Optional. If set, this DataStore is a federated search DataStore. + "alloyDbConfig": { # Stores information for connecting to AlloyDB. # AlloyDB config. If set, this DataStore is connected to AlloyDB. + "alloydbAiNlConfig": { # Configuration for AlloyDB AI Natural Language. # Optional. Configuration for Magic. + "nlConfigId": "A String", # Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty. + }, + "alloydbConnectionConfig": { # Configuration for connecting to AlloyDB. # Required. Configuration for connecting to AlloyDB. + "authMode": "A String", # Optional. Auth mode. + "database": "A String", # Required. The AlloyDB database to connect to. + "enablePsvs": True or False, # Optional. If true, enable PSVS for AlloyDB. + "instance": "A String", # Required. The AlloyDB instance to connect to. + "password": "A String", # Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user. + "user": "A String", # Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user. + }, + "returnedFields": [ # Optional. Fields to be returned in the search results. If empty, all fields will be returned. + "A String", + ], + }, + "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* + }, + "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. + "appName": "A String", # Optional. The type of the application. E.g., "jira", "box", etc. + "instanceName": "A String", # Optional. The instance name identifying the 3P app, e.g., "vaissptbots-my". This is different from the instance_uri which is the full URL of the 3P app e.g., "https://vaissptbots-my.sharepoint.com". + }, + }, "healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. @@ -1348,6 +1448,31 @@

Method Details

}, }, }, + "federatedSearchConfig": { # Stores information for federated search. # Optional. If set, this DataStore is a federated search DataStore. + "alloyDbConfig": { # Stores information for connecting to AlloyDB. # AlloyDB config. If set, this DataStore is connected to AlloyDB. + "alloydbAiNlConfig": { # Configuration for AlloyDB AI Natural Language. # Optional. Configuration for Magic. + "nlConfigId": "A String", # Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty. + }, + "alloydbConnectionConfig": { # Configuration for connecting to AlloyDB. # Required. Configuration for connecting to AlloyDB. + "authMode": "A String", # Optional. Auth mode. + "database": "A String", # Required. The AlloyDB database to connect to. + "enablePsvs": True or False, # Optional. If true, enable PSVS for AlloyDB. + "instance": "A String", # Required. The AlloyDB instance to connect to. + "password": "A String", # Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user. + "user": "A String", # Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user. + }, + "returnedFields": [ # Optional. Fields to be returned in the search results. If empty, all fields will be returned. + "A String", + ], + }, + "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* + }, + "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. + "appName": "A String", # Optional. The type of the application. E.g., "jira", "box", etc. + "instanceName": "A String", # Optional. The instance name identifying the 3P app, e.g., "vaissptbots-my". This is different from the instance_uri which is the full URL of the 3P app e.g., "https://vaissptbots-my.sharepoint.com". + }, + }, "healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. 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 f56e0ce49e..53fb54482f 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html @@ -413,6 +413,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -578,6 +581,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -1632,6 +1638,7 @@

Method Details

}, ], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. + "entity": "A String", # Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -1708,7 +1715,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. }, @@ -2003,8 +2010,8 @@

Method Details

"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. - "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. + "sessionSpec": { # Session specification. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, @@ -2015,7 +2022,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. "a_key": "A String", @@ -2651,8 +2658,8 @@

Method Details

"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. - "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. + "sessionSpec": { # Session specification. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, @@ -2663,7 +2670,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. "a_key": "A String", @@ -3411,6 +3418,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -3576,6 +3586,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.answers.html index 6542b9beea..d9a8088c93 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.answers.html @@ -169,6 +169,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. 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 9242cf79e1..979b8fae2a 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.html @@ -197,6 +197,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -513,6 +516,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -855,6 +861,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -1185,6 +1194,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -1519,6 +1531,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -1836,6 +1851,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.userEvents.html index ae3b4ec22a..d2b939d7c9 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.userEvents.html @@ -189,6 +189,7 @@

Method Details

}, ], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. + "entity": "A String", # Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -265,7 +266,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. }, @@ -387,6 +388,7 @@

Method Details

}, ], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. + "entity": "A String", # Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -463,7 +465,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. } @@ -510,6 +512,7 @@

Method Details

}, ], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. + "entity": "A String", # Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -586,7 +589,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. } diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.completionConfig.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.completionConfig.html index 412d5678d0..730ce6da91 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.completionConfig.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.completionConfig.html @@ -125,7 +125,7 @@

Method Details

"userInfo": { # Information of an end user. # Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 } @@ -294,7 +294,7 @@

Method Details

"userInfo": { # Information of an end user. # Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128. } 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 dc7de193cd..a5fa28fe37 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html @@ -413,6 +413,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -578,6 +581,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -1632,6 +1638,7 @@

Method Details

}, ], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. + "entity": "A String", # Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -1708,7 +1715,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. }, @@ -2003,8 +2010,8 @@

Method Details

"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. - "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. + "sessionSpec": { # Session specification. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, @@ -2015,7 +2022,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. "a_key": "A String", @@ -2651,8 +2658,8 @@

Method Details

"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. - "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. + "sessionSpec": { # Session specification. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, @@ -2663,7 +2670,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. "a_key": "A String", @@ -3411,6 +3418,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -3576,6 +3586,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.answers.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.answers.html index 78ef1b7a20..0de279815e 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.answers.html @@ -169,6 +169,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. 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 c49ffefb6a..19fccc1865 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.html @@ -212,6 +212,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -528,6 +531,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -870,6 +876,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -1200,6 +1209,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -1534,6 +1546,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -1851,6 +1866,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html index beca64c9f9..d4552b87f3 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html @@ -185,6 +185,13 @@

Method Details

"jsonActionParams": "A String", # Optional. Action parameters in json string format. "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. "useStaticSecrets": True or False, # Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored. + "userDefinedScopesMapping": { # Optional. Mapping from operation name to the list of scopes. Only be populated if there are user specified scopes. + "a_key": { # Stores a list of scopes. + "scopes": [ # Optional. The list of scopes. + "A String", + ], + }, + }, }, "actionState": "A String", # Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors. "alertPolicyConfigs": [ # Optional. The connector level alert config. @@ -221,7 +228,7 @@

Method Details

"policy": "A String", # Optional. The Sensitive Data Protection content policy resource name. }, }, - "dataSource": "A String", # Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`. + "dataSource": "A String", # Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk` "destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services. { # Defines target endpoints used to connect to third-party sources. "destinations": [ # Optional. The destinations for the corresponding key. @@ -424,6 +431,13 @@

Method Details

"jsonActionParams": "A String", # Optional. Action parameters in json string format. "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. "useStaticSecrets": True or False, # Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored. + "userDefinedScopesMapping": { # Optional. Mapping from operation name to the list of scopes. Only be populated if there are user specified scopes. + "a_key": { # Stores a list of scopes. + "scopes": [ # Optional. The list of scopes. + "A String", + ], + }, + }, }, "actionState": "A String", # Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors. "alertPolicyConfigs": [ # Optional. The connector level alert config. @@ -460,7 +474,7 @@

Method Details

"policy": "A String", # Optional. The Sensitive Data Protection content policy resource name. }, }, - "dataSource": "A String", # Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`. + "dataSource": "A String", # Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk` "destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services. { # Defines target endpoints used to connect to third-party sources. "destinations": [ # Optional. The destinations for the corresponding key. @@ -667,6 +681,13 @@

Method Details

"jsonActionParams": "A String", # Optional. Action parameters in json string format. "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. "useStaticSecrets": True or False, # Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored. + "userDefinedScopesMapping": { # Optional. Mapping from operation name to the list of scopes. Only be populated if there are user specified scopes. + "a_key": { # Stores a list of scopes. + "scopes": [ # Optional. The list of scopes. + "A String", + ], + }, + }, }, "actionState": "A String", # Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors. "alertPolicyConfigs": [ # Optional. The connector level alert config. @@ -703,7 +724,7 @@

Method Details

"policy": "A String", # Optional. The Sensitive Data Protection content policy resource name. }, }, - "dataSource": "A String", # Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`. + "dataSource": "A String", # Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk` "destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services. { # Defines target endpoints used to connect to third-party sources. "destinations": [ # Optional. The destinations for the corresponding key. @@ -920,6 +941,13 @@

Method Details

"jsonActionParams": "A String", # Optional. Action parameters in json string format. "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. "useStaticSecrets": True or False, # Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored. + "userDefinedScopesMapping": { # Optional. Mapping from operation name to the list of scopes. Only be populated if there are user specified scopes. + "a_key": { # Stores a list of scopes. + "scopes": [ # Optional. The list of scopes. + "A String", + ], + }, + }, }, "actionState": "A String", # Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors. "alertPolicyConfigs": [ # Optional. The connector level alert config. @@ -956,7 +984,7 @@

Method Details

"policy": "A String", # Optional. The Sensitive Data Protection content policy resource name. }, }, - "dataSource": "A String", # Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`. + "dataSource": "A String", # Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk` "destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services. { # Defines target endpoints used to connect to third-party sources. "destinations": [ # Optional. The destinations for the corresponding key. @@ -1183,6 +1211,13 @@

Method Details

"jsonActionParams": "A String", # Optional. Action parameters in json string format. "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. "useStaticSecrets": True or False, # Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored. + "userDefinedScopesMapping": { # Optional. Mapping from operation name to the list of scopes. Only be populated if there are user specified scopes. + "a_key": { # Stores a list of scopes. + "scopes": [ # Optional. The list of scopes. + "A String", + ], + }, + }, }, "actionState": "A String", # Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors. "alertPolicyConfigs": [ # Optional. The connector level alert config. @@ -1219,7 +1254,7 @@

Method Details

"policy": "A String", # Optional. The Sensitive Data Protection content policy resource name. }, }, - "dataSource": "A String", # Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`. + "dataSource": "A String", # Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk` "destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services. { # Defines target endpoints used to connect to third-party sources. "destinations": [ # Optional. The destinations for the corresponding key. @@ -1413,6 +1448,13 @@

Method Details

"jsonActionParams": "A String", # Optional. Action parameters in json string format. "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. "useStaticSecrets": True or False, # Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored. + "userDefinedScopesMapping": { # Optional. Mapping from operation name to the list of scopes. Only be populated if there are user specified scopes. + "a_key": { # Stores a list of scopes. + "scopes": [ # Optional. The list of scopes. + "A String", + ], + }, + }, }, "actionState": "A String", # Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors. "alertPolicyConfigs": [ # Optional. The connector level alert config. @@ -1449,7 +1491,7 @@

Method Details

"policy": "A String", # Optional. The Sensitive Data Protection content policy resource name. }, }, - "dataSource": "A String", # Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`. + "dataSource": "A String", # Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk` "destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services. { # Defines target endpoints used to connect to third-party sources. "destinations": [ # Optional. The destinations for the corresponding key. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.completionConfig.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.completionConfig.html index 1733ced151..5dc2d89ce5 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.completionConfig.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.completionConfig.html @@ -122,7 +122,7 @@

Method Details

"userInfo": { # Information of an end user. # Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 } diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html index fbb8e4eb14..dc20db29a7 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html @@ -381,6 +381,31 @@

Method Details

}, }, }, + "federatedSearchConfig": { # Stores information for federated search. # Optional. If set, this DataStore is a federated search DataStore. + "alloyDbConfig": { # Stores information for connecting to AlloyDB. # AlloyDB config. If set, this DataStore is connected to AlloyDB. + "alloydbAiNlConfig": { # Configuration for AlloyDB AI Natural Language. # Optional. Configuration for Magic. + "nlConfigId": "A String", # Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty. + }, + "alloydbConnectionConfig": { # Configuration for connecting to AlloyDB. # Required. Configuration for connecting to AlloyDB. + "authMode": "A String", # Optional. Auth mode. + "database": "A String", # Required. The AlloyDB database to connect to. + "enablePsvs": True or False, # Optional. If true, enable PSVS for AlloyDB. + "instance": "A String", # Required. The AlloyDB instance to connect to. + "password": "A String", # Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user. + "user": "A String", # Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user. + }, + "returnedFields": [ # Optional. Fields to be returned in the search results. If empty, all fields will be returned. + "A String", + ], + }, + "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* + }, + "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. + "appName": "A String", # Optional. The type of the application. E.g., "jira", "box", etc. + "instanceName": "A String", # Optional. The instance name identifying the 3P app, e.g., "vaissptbots-my". This is different from the instance_uri which is the full URL of the 3P app e.g., "https://vaissptbots-my.sharepoint.com". + }, + }, "healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. @@ -675,6 +700,31 @@

Method Details

}, }, }, + "federatedSearchConfig": { # Stores information for federated search. # Optional. If set, this DataStore is a federated search DataStore. + "alloyDbConfig": { # Stores information for connecting to AlloyDB. # AlloyDB config. If set, this DataStore is connected to AlloyDB. + "alloydbAiNlConfig": { # Configuration for AlloyDB AI Natural Language. # Optional. Configuration for Magic. + "nlConfigId": "A String", # Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty. + }, + "alloydbConnectionConfig": { # Configuration for connecting to AlloyDB. # Required. Configuration for connecting to AlloyDB. + "authMode": "A String", # Optional. Auth mode. + "database": "A String", # Required. The AlloyDB database to connect to. + "enablePsvs": True or False, # Optional. If true, enable PSVS for AlloyDB. + "instance": "A String", # Required. The AlloyDB instance to connect to. + "password": "A String", # Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user. + "user": "A String", # Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user. + }, + "returnedFields": [ # Optional. Fields to be returned in the search results. If empty, all fields will be returned. + "A String", + ], + }, + "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* + }, + "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. + "appName": "A String", # Optional. The type of the application. E.g., "jira", "box", etc. + "instanceName": "A String", # Optional. The instance name identifying the 3P app, e.g., "vaissptbots-my". This is different from the instance_uri which is the full URL of the 3P app e.g., "https://vaissptbots-my.sharepoint.com". + }, + }, "healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. @@ -966,6 +1016,31 @@

Method Details

}, }, }, + "federatedSearchConfig": { # Stores information for federated search. # Optional. If set, this DataStore is a federated search DataStore. + "alloyDbConfig": { # Stores information for connecting to AlloyDB. # AlloyDB config. If set, this DataStore is connected to AlloyDB. + "alloydbAiNlConfig": { # Configuration for AlloyDB AI Natural Language. # Optional. Configuration for Magic. + "nlConfigId": "A String", # Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty. + }, + "alloydbConnectionConfig": { # Configuration for connecting to AlloyDB. # Required. Configuration for connecting to AlloyDB. + "authMode": "A String", # Optional. Auth mode. + "database": "A String", # Required. The AlloyDB database to connect to. + "enablePsvs": True or False, # Optional. If true, enable PSVS for AlloyDB. + "instance": "A String", # Required. The AlloyDB instance to connect to. + "password": "A String", # Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user. + "user": "A String", # Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user. + }, + "returnedFields": [ # Optional. Fields to be returned in the search results. If empty, all fields will be returned. + "A String", + ], + }, + "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* + }, + "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. + "appName": "A String", # Optional. The type of the application. E.g., "jira", "box", etc. + "instanceName": "A String", # Optional. The instance name identifying the 3P app, e.g., "vaissptbots-my". This is different from the instance_uri which is the full URL of the 3P app e.g., "https://vaissptbots-my.sharepoint.com". + }, + }, "healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. @@ -1162,6 +1237,31 @@

Method Details

}, }, }, + "federatedSearchConfig": { # Stores information for federated search. # Optional. If set, this DataStore is a federated search DataStore. + "alloyDbConfig": { # Stores information for connecting to AlloyDB. # AlloyDB config. If set, this DataStore is connected to AlloyDB. + "alloydbAiNlConfig": { # Configuration for AlloyDB AI Natural Language. # Optional. Configuration for Magic. + "nlConfigId": "A String", # Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty. + }, + "alloydbConnectionConfig": { # Configuration for connecting to AlloyDB. # Required. Configuration for connecting to AlloyDB. + "authMode": "A String", # Optional. Auth mode. + "database": "A String", # Required. The AlloyDB database to connect to. + "enablePsvs": True or False, # Optional. If true, enable PSVS for AlloyDB. + "instance": "A String", # Required. The AlloyDB instance to connect to. + "password": "A String", # Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user. + "user": "A String", # Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user. + }, + "returnedFields": [ # Optional. Fields to be returned in the search results. If empty, all fields will be returned. + "A String", + ], + }, + "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* + }, + "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. + "appName": "A String", # Optional. The type of the application. E.g., "jira", "box", etc. + "instanceName": "A String", # Optional. The instance name identifying the 3P app, e.g., "vaissptbots-my". This is different from the instance_uri which is the full URL of the 3P app e.g., "https://vaissptbots-my.sharepoint.com". + }, + }, "healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. @@ -1340,6 +1440,31 @@

Method Details

}, }, }, + "federatedSearchConfig": { # Stores information for federated search. # Optional. If set, this DataStore is a federated search DataStore. + "alloyDbConfig": { # Stores information for connecting to AlloyDB. # AlloyDB config. If set, this DataStore is connected to AlloyDB. + "alloydbAiNlConfig": { # Configuration for AlloyDB AI Natural Language. # Optional. Configuration for Magic. + "nlConfigId": "A String", # Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty. + }, + "alloydbConnectionConfig": { # Configuration for connecting to AlloyDB. # Required. Configuration for connecting to AlloyDB. + "authMode": "A String", # Optional. Auth mode. + "database": "A String", # Required. The AlloyDB database to connect to. + "enablePsvs": True or False, # Optional. If true, enable PSVS for AlloyDB. + "instance": "A String", # Required. The AlloyDB instance to connect to. + "password": "A String", # Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user. + "user": "A String", # Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user. + }, + "returnedFields": [ # Optional. Fields to be returned in the search results. If empty, all fields will be returned. + "A String", + ], + }, + "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* + }, + "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. + "appName": "A String", # Optional. The type of the application. E.g., "jira", "box", etc. + "instanceName": "A String", # Optional. The instance name identifying the 3P app, e.g., "vaissptbots-my". This is different from the instance_uri which is the full URL of the 3P app e.g., "https://vaissptbots-my.sharepoint.com". + }, + }, "healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html index 0d574f4423..8b65a58876 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html @@ -413,6 +413,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -578,6 +581,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -1632,6 +1638,7 @@

Method Details

}, ], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. + "entity": "A String", # Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -1708,7 +1715,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. }, @@ -2003,8 +2010,8 @@

Method Details

"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. - "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. + "sessionSpec": { # Session specification. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, @@ -2015,7 +2022,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. "a_key": "A String", @@ -2651,8 +2658,8 @@

Method Details

"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. - "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. + "sessionSpec": { # Session specification. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, @@ -2663,7 +2670,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. "a_key": "A String", @@ -3411,6 +3418,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -3576,6 +3586,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.answers.html index 12b3765858..943694d1db 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.answers.html @@ -169,6 +169,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.html index 8888311620..59ddfd2ee5 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.html @@ -197,6 +197,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -513,6 +516,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -855,6 +861,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -1185,6 +1194,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -1519,6 +1531,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -1836,6 +1851,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.userEvents.html index ca8b25aa88..610c17021d 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.userEvents.html @@ -189,6 +189,7 @@

Method Details

}, ], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. + "entity": "A String", # Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -265,7 +266,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. }, @@ -387,6 +388,7 @@

Method Details

}, ], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. + "entity": "A String", # Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -463,7 +465,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. } @@ -510,6 +512,7 @@

Method Details

}, ], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. + "entity": "A String", # Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -586,7 +589,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. } diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html index 13c7b56c16..cf52bd1986 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html @@ -345,8 +345,8 @@

Method Details

"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. - "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. + "sessionSpec": { # Session specification. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, @@ -357,7 +357,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. "a_key": "A String", @@ -674,8 +674,8 @@

Method Details

"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. - "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. + "sessionSpec": { # Session specification. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, @@ -686,7 +686,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. "a_key": "A String", @@ -979,8 +979,8 @@

Method Details

"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. - "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. + "sessionSpec": { # Session specification. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, @@ -991,7 +991,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. "a_key": "A String", diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.html index 435bf411df..660b143c41 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.html @@ -1052,6 +1052,13 @@

Method Details

"jsonActionParams": "A String", # Optional. Action parameters in json string format. "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. "useStaticSecrets": True or False, # Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored. + "userDefinedScopesMapping": { # Optional. Mapping from operation name to the list of scopes. Only be populated if there are user specified scopes. + "a_key": { # Stores a list of scopes. + "scopes": [ # Optional. The list of scopes. + "A String", + ], + }, + }, }, "actionState": "A String", # Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors. "alertPolicyConfigs": [ # Optional. The connector level alert config. @@ -1088,7 +1095,7 @@

Method Details

"policy": "A String", # Optional. The Sensitive Data Protection content policy resource name. }, }, - "dataSource": "A String", # Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`. + "dataSource": "A String", # Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk` "destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services. { # Defines target endpoints used to connect to third-party sources. "destinations": [ # Optional. The destinations for the corresponding key. @@ -1312,6 +1319,13 @@

Method Details

"jsonActionParams": "A String", # Optional. Action parameters in json string format. "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. "useStaticSecrets": True or False, # Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored. + "userDefinedScopesMapping": { # Optional. Mapping from operation name to the list of scopes. Only be populated if there are user specified scopes. + "a_key": { # Stores a list of scopes. + "scopes": [ # Optional. The list of scopes. + "A String", + ], + }, + }, }, "actionState": "A String", # Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors. "alertPolicyConfigs": [ # Optional. The connector level alert config. @@ -1348,7 +1362,7 @@

Method Details

"policy": "A String", # Optional. The Sensitive Data Protection content policy resource name. }, }, - "dataSource": "A String", # Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`. + "dataSource": "A String", # Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk` "destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services. { # Defines target endpoints used to connect to third-party sources. "destinations": [ # Optional. The destinations for the corresponding key. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.userEvents.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.userEvents.html index 13a044c36b..8d759010b5 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.userEvents.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.userEvents.html @@ -186,6 +186,7 @@

Method Details

}, ], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. + "entity": "A String", # Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -262,7 +263,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. }, @@ -341,6 +342,7 @@

Method Details

}, ], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. + "entity": "A String", # Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -417,7 +419,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. } @@ -464,6 +466,7 @@

Method Details

}, ], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. + "entity": "A String", # Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -540,7 +543,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. } diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.completionConfig.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.completionConfig.html index 21553f5219..536174f169 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.completionConfig.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.completionConfig.html @@ -122,7 +122,7 @@

Method Details

"userInfo": { # Information of an end user. # Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 } diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html index 7ed62b1dd1..4f74868d3f 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html @@ -321,6 +321,31 @@

Method Details

}, }, }, + "federatedSearchConfig": { # Stores information for federated search. # Optional. If set, this DataStore is a federated search DataStore. + "alloyDbConfig": { # Stores information for connecting to AlloyDB. # AlloyDB config. If set, this DataStore is connected to AlloyDB. + "alloydbAiNlConfig": { # Configuration for AlloyDB AI Natural Language. # Optional. Configuration for Magic. + "nlConfigId": "A String", # Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty. + }, + "alloydbConnectionConfig": { # Configuration for connecting to AlloyDB. # Required. Configuration for connecting to AlloyDB. + "authMode": "A String", # Optional. Auth mode. + "database": "A String", # Required. The AlloyDB database to connect to. + "enablePsvs": True or False, # Optional. If true, enable PSVS for AlloyDB. + "instance": "A String", # Required. The AlloyDB instance to connect to. + "password": "A String", # Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user. + "user": "A String", # Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user. + }, + "returnedFields": [ # Optional. Fields to be returned in the search results. If empty, all fields will be returned. + "A String", + ], + }, + "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* + }, + "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. + "appName": "A String", # Optional. The type of the application. E.g., "jira", "box", etc. + "instanceName": "A String", # Optional. The instance name identifying the 3P app, e.g., "vaissptbots-my". This is different from the instance_uri which is the full URL of the 3P app e.g., "https://vaissptbots-my.sharepoint.com". + }, + }, "healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. @@ -547,6 +572,31 @@

Method Details

}, }, }, + "federatedSearchConfig": { # Stores information for federated search. # Optional. If set, this DataStore is a federated search DataStore. + "alloyDbConfig": { # Stores information for connecting to AlloyDB. # AlloyDB config. If set, this DataStore is connected to AlloyDB. + "alloydbAiNlConfig": { # Configuration for AlloyDB AI Natural Language. # Optional. Configuration for Magic. + "nlConfigId": "A String", # Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty. + }, + "alloydbConnectionConfig": { # Configuration for connecting to AlloyDB. # Required. Configuration for connecting to AlloyDB. + "authMode": "A String", # Optional. Auth mode. + "database": "A String", # Required. The AlloyDB database to connect to. + "enablePsvs": True or False, # Optional. If true, enable PSVS for AlloyDB. + "instance": "A String", # Required. The AlloyDB instance to connect to. + "password": "A String", # Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user. + "user": "A String", # Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user. + }, + "returnedFields": [ # Optional. Fields to be returned in the search results. If empty, all fields will be returned. + "A String", + ], + }, + "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* + }, + "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. + "appName": "A String", # Optional. The type of the application. E.g., "jira", "box", etc. + "instanceName": "A String", # Optional. The instance name identifying the 3P app, e.g., "vaissptbots-my". This is different from the instance_uri which is the full URL of the 3P app e.g., "https://vaissptbots-my.sharepoint.com". + }, + }, "healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. @@ -729,6 +779,31 @@

Method Details

}, }, }, + "federatedSearchConfig": { # Stores information for federated search. # Optional. If set, this DataStore is a federated search DataStore. + "alloyDbConfig": { # Stores information for connecting to AlloyDB. # AlloyDB config. If set, this DataStore is connected to AlloyDB. + "alloydbAiNlConfig": { # Configuration for AlloyDB AI Natural Language. # Optional. Configuration for Magic. + "nlConfigId": "A String", # Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty. + }, + "alloydbConnectionConfig": { # Configuration for connecting to AlloyDB. # Required. Configuration for connecting to AlloyDB. + "authMode": "A String", # Optional. Auth mode. + "database": "A String", # Required. The AlloyDB database to connect to. + "enablePsvs": True or False, # Optional. If true, enable PSVS for AlloyDB. + "instance": "A String", # Required. The AlloyDB instance to connect to. + "password": "A String", # Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user. + "user": "A String", # Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user. + }, + "returnedFields": [ # Optional. Fields to be returned in the search results. If empty, all fields will be returned. + "A String", + ], + }, + "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* + }, + "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. + "appName": "A String", # Optional. The type of the application. E.g., "jira", "box", etc. + "instanceName": "A String", # Optional. The instance name identifying the 3P app, e.g., "vaissptbots-my". This is different from the instance_uri which is the full URL of the 3P app e.g., "https://vaissptbots-my.sharepoint.com". + }, + }, "healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. @@ -899,6 +974,31 @@

Method Details

}, }, }, + "federatedSearchConfig": { # Stores information for federated search. # Optional. If set, this DataStore is a federated search DataStore. + "alloyDbConfig": { # Stores information for connecting to AlloyDB. # AlloyDB config. If set, this DataStore is connected to AlloyDB. + "alloydbAiNlConfig": { # Configuration for AlloyDB AI Natural Language. # Optional. Configuration for Magic. + "nlConfigId": "A String", # Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty. + }, + "alloydbConnectionConfig": { # Configuration for connecting to AlloyDB. # Required. Configuration for connecting to AlloyDB. + "authMode": "A String", # Optional. Auth mode. + "database": "A String", # Required. The AlloyDB database to connect to. + "enablePsvs": True or False, # Optional. If true, enable PSVS for AlloyDB. + "instance": "A String", # Required. The AlloyDB instance to connect to. + "password": "A String", # Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user. + "user": "A String", # Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user. + }, + "returnedFields": [ # Optional. Fields to be returned in the search results. If empty, all fields will be returned. + "A String", + ], + }, + "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* + }, + "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. + "appName": "A String", # Optional. The type of the application. E.g., "jira", "box", etc. + "instanceName": "A String", # Optional. The instance name identifying the 3P app, e.g., "vaissptbots-my". This is different from the instance_uri which is the full URL of the 3P app e.g., "https://vaissptbots-my.sharepoint.com". + }, + }, "healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. @@ -1051,6 +1151,31 @@

Method Details

}, }, }, + "federatedSearchConfig": { # Stores information for federated search. # Optional. If set, this DataStore is a federated search DataStore. + "alloyDbConfig": { # Stores information for connecting to AlloyDB. # AlloyDB config. If set, this DataStore is connected to AlloyDB. + "alloydbAiNlConfig": { # Configuration for AlloyDB AI Natural Language. # Optional. Configuration for Magic. + "nlConfigId": "A String", # Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty. + }, + "alloydbConnectionConfig": { # Configuration for connecting to AlloyDB. # Required. Configuration for connecting to AlloyDB. + "authMode": "A String", # Optional. Auth mode. + "database": "A String", # Required. The AlloyDB database to connect to. + "enablePsvs": True or False, # Optional. If true, enable PSVS for AlloyDB. + "instance": "A String", # Required. The AlloyDB instance to connect to. + "password": "A String", # Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user. + "user": "A String", # Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user. + }, + "returnedFields": [ # Optional. Fields to be returned in the search results. If empty, all fields will be returned. + "A String", + ], + }, + "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* + }, + "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. + "appName": "A String", # Optional. The type of the application. E.g., "jira", "box", etc. + "instanceName": "A String", # Optional. The instance name identifying the 3P app, e.g., "vaissptbots-my". This is different from the instance_uri which is the full URL of the 3P app e.g., "https://vaissptbots-my.sharepoint.com". + }, + }, "healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. 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 41498875b2..5ffce3be32 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html @@ -378,6 +378,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -543,6 +546,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -1516,6 +1522,7 @@

Method Details

}, ], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. + "entity": "A String", # Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -1592,7 +1599,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. }, @@ -1884,8 +1891,8 @@

Method Details

"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. - "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. + "sessionSpec": { # Session specification. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, @@ -1895,7 +1902,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. "a_key": "A String", @@ -2528,8 +2535,8 @@

Method Details

"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. - "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. + "sessionSpec": { # Session specification. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, @@ -2539,7 +2546,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. "a_key": "A String", @@ -3252,6 +3259,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -3417,6 +3427,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.answers.html index 8bd3e070b8..77834ee28b 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.answers.html @@ -169,6 +169,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. 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 a1ae9cf4b3..0b0d4c523b 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.html @@ -197,6 +197,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -480,6 +483,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -789,6 +795,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -1086,6 +1095,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -1387,6 +1399,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -1671,6 +1686,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.userEvents.html index 9824203f73..cf858e3732 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.userEvents.html @@ -189,6 +189,7 @@

Method Details

}, ], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. + "entity": "A String", # Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -265,7 +266,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. }, @@ -387,6 +388,7 @@

Method Details

}, ], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. + "entity": "A String", # Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -463,7 +465,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. } @@ -510,6 +512,7 @@

Method Details

}, ], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. + "entity": "A String", # Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -586,7 +589,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. } diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.completionConfig.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.completionConfig.html index a269af978b..15649ca03f 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.completionConfig.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.completionConfig.html @@ -125,7 +125,7 @@

Method Details

"userInfo": { # Information of an end user. # Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 } @@ -294,7 +294,7 @@

Method Details

"userInfo": { # Information of an end user. # Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128. } 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 cf1a69e310..84ca0ef64c 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html @@ -378,6 +378,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -543,6 +546,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -1516,6 +1522,7 @@

Method Details

}, ], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. + "entity": "A String", # Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -1592,7 +1599,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. }, @@ -1884,8 +1891,8 @@

Method Details

"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. - "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. + "sessionSpec": { # Session specification. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, @@ -1895,7 +1902,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. "a_key": "A String", @@ -2528,8 +2535,8 @@

Method Details

"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. - "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. + "sessionSpec": { # Session specification. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, @@ -2539,7 +2546,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. "a_key": "A String", @@ -3252,6 +3259,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -3417,6 +3427,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.answers.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.answers.html index c375a56741..b716a1b7c9 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.answers.html @@ -169,6 +169,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. 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 17b5c448b0..d4d67f7417 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.html @@ -197,6 +197,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -480,6 +483,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -789,6 +795,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -1086,6 +1095,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -1387,6 +1399,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -1671,6 +1686,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.completionConfig.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.completionConfig.html index ce9898f07a..c47b8aa364 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.completionConfig.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.completionConfig.html @@ -122,7 +122,7 @@

Method Details

"userInfo": { # Information of an end user. # Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 } diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html index 34f7d0a52d..a29c57cab5 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html @@ -313,6 +313,31 @@

Method Details

}, }, }, + "federatedSearchConfig": { # Stores information for federated search. # Optional. If set, this DataStore is a federated search DataStore. + "alloyDbConfig": { # Stores information for connecting to AlloyDB. # AlloyDB config. If set, this DataStore is connected to AlloyDB. + "alloydbAiNlConfig": { # Configuration for AlloyDB AI Natural Language. # Optional. Configuration for Magic. + "nlConfigId": "A String", # Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty. + }, + "alloydbConnectionConfig": { # Configuration for connecting to AlloyDB. # Required. Configuration for connecting to AlloyDB. + "authMode": "A String", # Optional. Auth mode. + "database": "A String", # Required. The AlloyDB database to connect to. + "enablePsvs": True or False, # Optional. If true, enable PSVS for AlloyDB. + "instance": "A String", # Required. The AlloyDB instance to connect to. + "password": "A String", # Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user. + "user": "A String", # Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user. + }, + "returnedFields": [ # Optional. Fields to be returned in the search results. If empty, all fields will be returned. + "A String", + ], + }, + "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* + }, + "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. + "appName": "A String", # Optional. The type of the application. E.g., "jira", "box", etc. + "instanceName": "A String", # Optional. The instance name identifying the 3P app, e.g., "vaissptbots-my". This is different from the instance_uri which is the full URL of the 3P app e.g., "https://vaissptbots-my.sharepoint.com". + }, + }, "healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. @@ -539,6 +564,31 @@

Method Details

}, }, }, + "federatedSearchConfig": { # Stores information for federated search. # Optional. If set, this DataStore is a federated search DataStore. + "alloyDbConfig": { # Stores information for connecting to AlloyDB. # AlloyDB config. If set, this DataStore is connected to AlloyDB. + "alloydbAiNlConfig": { # Configuration for AlloyDB AI Natural Language. # Optional. Configuration for Magic. + "nlConfigId": "A String", # Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty. + }, + "alloydbConnectionConfig": { # Configuration for connecting to AlloyDB. # Required. Configuration for connecting to AlloyDB. + "authMode": "A String", # Optional. Auth mode. + "database": "A String", # Required. The AlloyDB database to connect to. + "enablePsvs": True or False, # Optional. If true, enable PSVS for AlloyDB. + "instance": "A String", # Required. The AlloyDB instance to connect to. + "password": "A String", # Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user. + "user": "A String", # Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user. + }, + "returnedFields": [ # Optional. Fields to be returned in the search results. If empty, all fields will be returned. + "A String", + ], + }, + "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* + }, + "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. + "appName": "A String", # Optional. The type of the application. E.g., "jira", "box", etc. + "instanceName": "A String", # Optional. The instance name identifying the 3P app, e.g., "vaissptbots-my". This is different from the instance_uri which is the full URL of the 3P app e.g., "https://vaissptbots-my.sharepoint.com". + }, + }, "healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. @@ -721,6 +771,31 @@

Method Details

}, }, }, + "federatedSearchConfig": { # Stores information for federated search. # Optional. If set, this DataStore is a federated search DataStore. + "alloyDbConfig": { # Stores information for connecting to AlloyDB. # AlloyDB config. If set, this DataStore is connected to AlloyDB. + "alloydbAiNlConfig": { # Configuration for AlloyDB AI Natural Language. # Optional. Configuration for Magic. + "nlConfigId": "A String", # Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty. + }, + "alloydbConnectionConfig": { # Configuration for connecting to AlloyDB. # Required. Configuration for connecting to AlloyDB. + "authMode": "A String", # Optional. Auth mode. + "database": "A String", # Required. The AlloyDB database to connect to. + "enablePsvs": True or False, # Optional. If true, enable PSVS for AlloyDB. + "instance": "A String", # Required. The AlloyDB instance to connect to. + "password": "A String", # Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user. + "user": "A String", # Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user. + }, + "returnedFields": [ # Optional. Fields to be returned in the search results. If empty, all fields will be returned. + "A String", + ], + }, + "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* + }, + "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. + "appName": "A String", # Optional. The type of the application. E.g., "jira", "box", etc. + "instanceName": "A String", # Optional. The instance name identifying the 3P app, e.g., "vaissptbots-my". This is different from the instance_uri which is the full URL of the 3P app e.g., "https://vaissptbots-my.sharepoint.com". + }, + }, "healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. @@ -891,6 +966,31 @@

Method Details

}, }, }, + "federatedSearchConfig": { # Stores information for federated search. # Optional. If set, this DataStore is a federated search DataStore. + "alloyDbConfig": { # Stores information for connecting to AlloyDB. # AlloyDB config. If set, this DataStore is connected to AlloyDB. + "alloydbAiNlConfig": { # Configuration for AlloyDB AI Natural Language. # Optional. Configuration for Magic. + "nlConfigId": "A String", # Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty. + }, + "alloydbConnectionConfig": { # Configuration for connecting to AlloyDB. # Required. Configuration for connecting to AlloyDB. + "authMode": "A String", # Optional. Auth mode. + "database": "A String", # Required. The AlloyDB database to connect to. + "enablePsvs": True or False, # Optional. If true, enable PSVS for AlloyDB. + "instance": "A String", # Required. The AlloyDB instance to connect to. + "password": "A String", # Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user. + "user": "A String", # Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user. + }, + "returnedFields": [ # Optional. Fields to be returned in the search results. If empty, all fields will be returned. + "A String", + ], + }, + "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* + }, + "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. + "appName": "A String", # Optional. The type of the application. E.g., "jira", "box", etc. + "instanceName": "A String", # Optional. The instance name identifying the 3P app, e.g., "vaissptbots-my". This is different from the instance_uri which is the full URL of the 3P app e.g., "https://vaissptbots-my.sharepoint.com". + }, + }, "healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. @@ -1043,6 +1143,31 @@

Method Details

}, }, }, + "federatedSearchConfig": { # Stores information for federated search. # Optional. If set, this DataStore is a federated search DataStore. + "alloyDbConfig": { # Stores information for connecting to AlloyDB. # AlloyDB config. If set, this DataStore is connected to AlloyDB. + "alloydbAiNlConfig": { # Configuration for AlloyDB AI Natural Language. # Optional. Configuration for Magic. + "nlConfigId": "A String", # Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty. + }, + "alloydbConnectionConfig": { # Configuration for connecting to AlloyDB. # Required. Configuration for connecting to AlloyDB. + "authMode": "A String", # Optional. Auth mode. + "database": "A String", # Required. The AlloyDB database to connect to. + "enablePsvs": True or False, # Optional. If true, enable PSVS for AlloyDB. + "instance": "A String", # Required. The AlloyDB instance to connect to. + "password": "A String", # Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user. + "user": "A String", # Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user. + }, + "returnedFields": [ # Optional. Fields to be returned in the search results. If empty, all fields will be returned. + "A String", + ], + }, + "notebooklmConfig": { # Config for connecting to NotebookLM Enterprise. # NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. + "searchConfig": "A String", # Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/* + }, + "thirdPartyOauthConfig": { # Stores information for third party applicationOAuth. # Third Party OAuth config. If set, this DataStore is connected to a third party application. + "appName": "A String", # Optional. The type of the application. E.g., "jira", "box", etc. + "instanceName": "A String", # Optional. The instance name identifying the 3P app, e.g., "vaissptbots-my". This is different from the instance_uri which is the full URL of the 3P app e.g., "https://vaissptbots-my.sharepoint.com". + }, + }, "healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html index 6cd63c93a8..b2e6890e0f 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html @@ -378,6 +378,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -543,6 +546,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -1516,6 +1522,7 @@

Method Details

}, ], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. + "entity": "A String", # Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -1592,7 +1599,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. }, @@ -1884,8 +1891,8 @@

Method Details

"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. - "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. + "sessionSpec": { # Session specification. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, @@ -1895,7 +1902,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. "a_key": "A String", @@ -2528,8 +2535,8 @@

Method Details

"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. - "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. + "sessionSpec": { # Session specification. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, @@ -2539,7 +2546,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. "a_key": "A String", @@ -3252,6 +3259,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -3417,6 +3427,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.answers.html index 776d08a0ee..663d368c53 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.answers.html @@ -169,6 +169,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.html index d4df0aca81..7ad49828f9 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.html @@ -197,6 +197,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -480,6 +483,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -789,6 +795,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -1086,6 +1095,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -1387,6 +1399,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. @@ -1671,6 +1686,9 @@

Method Details

}, "relevanceScore": 3.14, # The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. }, + "queries": [ # Output only. The search queries that produced this reference. + "A String", + ], "structuredDocumentInfo": { # Structured search information. # Structured document information. "document": "A String", # Document resource name. "structData": { # Structured search data. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.userEvents.html index 7e1f09fd5a..85df34b81c 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.userEvents.html @@ -189,6 +189,7 @@

Method Details

}, ], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. + "entity": "A String", # Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -265,7 +266,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. }, @@ -387,6 +388,7 @@

Method Details

}, ], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. + "entity": "A String", # Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -463,7 +465,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. } @@ -510,6 +512,7 @@

Method Details

}, ], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. + "entity": "A String", # Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -586,7 +589,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. } diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html index 5a0cb19cf2..e4e7753ffd 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html @@ -342,8 +342,8 @@

Method Details

"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. - "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. + "sessionSpec": { # Session specification. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, @@ -353,7 +353,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. "a_key": "A String", @@ -667,8 +667,8 @@

Method Details

"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. - "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. + "sessionSpec": { # Session specification. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, @@ -678,7 +678,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. "a_key": "A String", @@ -968,8 +968,8 @@

Method Details

"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. - "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. + "sessionSpec": { # Session specification. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. }, @@ -979,7 +979,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. "a_key": "A String", diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.userEvents.html b/docs/dyn/discoveryengine_v1beta.projects.locations.userEvents.html index b19ed2840a..cc4d76ffd2 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.userEvents.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.userEvents.html @@ -186,6 +186,7 @@

Method Details

}, ], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. + "entity": "A String", # Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -262,7 +263,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. }, @@ -341,6 +342,7 @@

Method Details

}, ], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. + "entity": "A String", # Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -417,7 +419,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. } @@ -464,6 +466,7 @@

Method Details

}, ], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. + "entity": "A String", # Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -540,7 +543,7 @@

Method Details

"userInfo": { # Information of an end user. # Information about the end user. "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. - "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. }, "userPseudoId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. } diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json index 5a70fb1ad4..f9172680fc 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json @@ -9218,7 +9218,7 @@ } } }, -"revision": "20260226", +"revision": "20260301", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "A2aV1APIKeySecurityScheme": { @@ -10629,6 +10629,27 @@ "useStaticSecrets": { "description": "Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored.", "type": "boolean" +}, +"userDefinedScopesMapping": { +"additionalProperties": { +"$ref": "GoogleCloudDiscoveryengineV1ActionConfigScopeList" +}, +"description": "Optional. Mapping from operation name to the list of scopes. Only be populated if there are user specified scopes.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1ActionConfigScopeList": { +"description": "Stores a list of scopes.", +"id": "GoogleCloudDiscoveryengineV1ActionConfigScopeList", +"properties": { +"scopes": { +"description": "Optional. The list of scopes.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" @@ -11930,6 +11951,14 @@ "$ref": "GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo", "description": "Chunk information." }, +"queries": { +"description": "Output only. The search queries that produced this reference.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "structuredDocumentInfo": { "$ref": "GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo", "description": "Structured document information." @@ -14586,7 +14615,7 @@ "type": "string" }, "dataSource": { -"description": "Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`.", +"description": "Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk`", "type": "string" }, "destinationConfigs": { @@ -15024,6 +15053,10 @@ "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", "description": "Configuration for Document understanding and enrichment." }, +"federatedSearchConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfig", +"description": "Optional. If set, this DataStore is a federated search DataStore." +}, "healthcareFhirConfig": { "$ref": "GoogleCloudDiscoveryengineV1HealthcareFhirConfig", "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." @@ -15139,6 +15172,125 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfig": { +"description": "Stores information for federated search.", +"id": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfig", +"properties": { +"alloyDbConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfig", +"description": "AlloyDB config. If set, this DataStore is connected to AlloyDB." +}, +"notebooklmConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigNotebooklmConfig", +"description": "NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise." +}, +"thirdPartyOauthConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigThirdPartyOauthConfig", +"description": "Third Party OAuth config. If set, this DataStore is connected to a third party application." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfig": { +"description": "Stores information for connecting to AlloyDB.", +"id": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfig", +"properties": { +"alloydbAiNlConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig", +"description": "Optional. Configuration for Magic." +}, +"alloydbConnectionConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig", +"description": "Required. Configuration for connecting to AlloyDB." +}, +"returnedFields": { +"description": "Optional. Fields to be returned in the search results. If empty, all fields will be returned.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig": { +"description": "Configuration for AlloyDB AI Natural Language.", +"id": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig", +"properties": { +"nlConfigId": { +"description": "Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig": { +"description": "Configuration for connecting to AlloyDB.", +"id": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig", +"properties": { +"authMode": { +"description": "Optional. Auth mode.", +"enum": [ +"AUTH_MODE_UNSPECIFIED", +"AUTH_MODE_SERVICE_ACCOUNT", +"AUTH_MODE_END_USER_ACCOUNT" +], +"enumDescriptions": [ +"", +"Uses P4SA when VAIS talks to AlloyDB.", +"Uses EUC when VAIS talks to AlloyDB." +], +"type": "string" +}, +"database": { +"description": "Required. The AlloyDB database to connect to.", +"type": "string" +}, +"enablePsvs": { +"description": "Optional. If true, enable PSVS for AlloyDB.", +"type": "boolean" +}, +"instance": { +"description": "Required. The AlloyDB instance to connect to.", +"type": "string" +}, +"password": { +"description": "Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user.", +"type": "string" +}, +"user": { +"description": "Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigNotebooklmConfig": { +"description": "Config for connecting to NotebookLM Enterprise.", +"id": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigNotebooklmConfig", +"properties": { +"searchConfig": { +"description": "Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/*", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigThirdPartyOauthConfig": { +"description": "Stores information for third party applicationOAuth.", +"id": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigThirdPartyOauthConfig", +"properties": { +"appName": { +"description": "Optional. The type of the application. E.g., \"jira\", \"box\", etc.", +"type": "string" +}, +"instanceName": { +"description": "Optional. The instance name identifying the 3P app, e.g., \"vaissptbots-my\". This is different from the instance_uri which is the full URL of the 3P app e.g., \"https://vaissptbots-my.sharepoint.com\".", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore": { "description": "Stores information regarding the serving configurations at DataStore level.", "id": "GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore", @@ -18530,7 +18682,7 @@ false "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." }, "session": { -"description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", +"description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call.", "type": "string" }, "sessionSpec": { @@ -19098,7 +19250,7 @@ false "type": "object" }, "GoogleCloudDiscoveryengineV1SearchRequestSessionSpec": { -"description": "Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", +"description": "Session specification.", "id": "GoogleCloudDiscoveryengineV1SearchRequestSessionSpec", "properties": { "queryId": { @@ -20677,6 +20829,10 @@ false "description": "The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search.", "type": "string" }, +"entity": { +"description": "Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results.", +"type": "string" +}, "eventTime": { "description": "Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened.", "format": "google-datetime", @@ -20759,7 +20915,7 @@ false "type": "string" }, "userId": { -"description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded.", "type": "string" } }, @@ -21733,6 +21889,27 @@ false "useStaticSecrets": { "description": "Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored.", "type": "boolean" +}, +"userDefinedScopesMapping": { +"additionalProperties": { +"$ref": "GoogleCloudDiscoveryengineV1alphaActionConfigScopeList" +}, +"description": "Optional. Mapping from operation name to the list of scopes. Only be populated if there are user specified scopes.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaActionConfigScopeList": { +"description": "Stores a list of scopes.", +"id": "GoogleCloudDiscoveryengineV1alphaActionConfigScopeList", +"properties": { +"scopes": { +"description": "Optional. The list of scopes.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" @@ -22182,6 +22359,14 @@ false "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", "description": "Chunk information." }, +"queries": { +"description": "Output only. The search queries that produced this reference.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "structuredDocumentInfo": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo", "description": "Structured document information." @@ -23933,7 +24118,7 @@ false "description": "Optional. Specifies the data protection policy for the connector." }, "dataSource": { -"description": "Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`.", +"description": "Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk`", "type": "string" }, "destinationConfigs": { @@ -24393,6 +24578,10 @@ false "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", "description": "Configuration for Document understanding and enrichment." }, +"federatedSearchConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfig", +"description": "Optional. If set, this DataStore is a federated search DataStore." +}, "healthcareFhirConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig", "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." @@ -24517,6 +24706,125 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfig": { +"description": "Stores information for federated search.", +"id": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfig", +"properties": { +"alloyDbConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfig", +"description": "AlloyDB config. If set, this DataStore is connected to AlloyDB." +}, +"notebooklmConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigNotebooklmConfig", +"description": "NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise." +}, +"thirdPartyOauthConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigThirdPartyOauthConfig", +"description": "Third Party OAuth config. If set, this DataStore is connected to a third party application." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfig": { +"description": "Stores information for connecting to AlloyDB.", +"id": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfig", +"properties": { +"alloydbAiNlConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig", +"description": "Optional. Configuration for Magic." +}, +"alloydbConnectionConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig", +"description": "Required. Configuration for connecting to AlloyDB." +}, +"returnedFields": { +"description": "Optional. Fields to be returned in the search results. If empty, all fields will be returned.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig": { +"description": "Configuration for AlloyDB AI Natural Language.", +"id": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig", +"properties": { +"nlConfigId": { +"description": "Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig": { +"description": "Configuration for connecting to AlloyDB.", +"id": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig", +"properties": { +"authMode": { +"description": "Optional. Auth mode.", +"enum": [ +"AUTH_MODE_UNSPECIFIED", +"AUTH_MODE_SERVICE_ACCOUNT", +"AUTH_MODE_END_USER_ACCOUNT" +], +"enumDescriptions": [ +"", +"Uses P4SA when VAIS talks to AlloyDB.", +"Uses EUC when VAIS talks to AlloyDB." +], +"type": "string" +}, +"database": { +"description": "Required. The AlloyDB database to connect to.", +"type": "string" +}, +"enablePsvs": { +"description": "Optional. If true, enable PSVS for AlloyDB.", +"type": "boolean" +}, +"instance": { +"description": "Required. The AlloyDB instance to connect to.", +"type": "string" +}, +"password": { +"description": "Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user.", +"type": "string" +}, +"user": { +"description": "Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigNotebooklmConfig": { +"description": "Config for connecting to NotebookLM Enterprise.", +"id": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigNotebooklmConfig", +"properties": { +"searchConfig": { +"description": "Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/*", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigThirdPartyOauthConfig": { +"description": "Stores information for third party applicationOAuth.", +"id": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigThirdPartyOauthConfig", +"properties": { +"appName": { +"description": "Optional. The type of the application. E.g., \"jira\", \"box\", etc.", +"type": "string" +}, +"instanceName": { +"description": "Optional. The instance name identifying the 3P app, e.g., \"vaissptbots-my\". This is different from the instance_uri which is the full URL of the 3P app e.g., \"https://vaissptbots-my.sharepoint.com\".", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore": { "description": "Stores information regarding the serving configurations at DataStore level.", "id": "GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore", @@ -27691,7 +27999,7 @@ false "type": "string" }, "session": { -"description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", +"description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call.", "type": "string" }, "sessionSpec": { @@ -28413,7 +28721,7 @@ false "type": "object" }, "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec": { -"description": "Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", +"description": "Session specification.", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec", "properties": { "queryId": { @@ -28965,7 +29273,7 @@ false "type": "string" }, "userId": { -"description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded.", "type": "string" } }, @@ -29737,6 +30045,10 @@ false "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", "description": "Configuration for Document understanding and enrichment." }, +"federatedSearchConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfig", +"description": "Optional. If set, this DataStore is a federated search DataStore." +}, "healthcareFhirConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig", "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." @@ -29856,6 +30168,125 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfig": { +"description": "Stores information for federated search.", +"id": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfig", +"properties": { +"alloyDbConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfig", +"description": "AlloyDB config. If set, this DataStore is connected to AlloyDB." +}, +"notebooklmConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigNotebooklmConfig", +"description": "NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise." +}, +"thirdPartyOauthConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigThirdPartyOauthConfig", +"description": "Third Party OAuth config. If set, this DataStore is connected to a third party application." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfig": { +"description": "Stores information for connecting to AlloyDB.", +"id": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfig", +"properties": { +"alloydbAiNlConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig", +"description": "Optional. Configuration for Magic." +}, +"alloydbConnectionConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig", +"description": "Required. Configuration for connecting to AlloyDB." +}, +"returnedFields": { +"description": "Optional. Fields to be returned in the search results. If empty, all fields will be returned.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig": { +"description": "Configuration for AlloyDB AI Natural Language.", +"id": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig", +"properties": { +"nlConfigId": { +"description": "Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig": { +"description": "Configuration for connecting to AlloyDB.", +"id": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig", +"properties": { +"authMode": { +"description": "Optional. Auth mode.", +"enum": [ +"AUTH_MODE_UNSPECIFIED", +"AUTH_MODE_SERVICE_ACCOUNT", +"AUTH_MODE_END_USER_ACCOUNT" +], +"enumDescriptions": [ +"", +"Uses P4SA when VAIS talks to AlloyDB.", +"Uses EUC when VAIS talks to AlloyDB." +], +"type": "string" +}, +"database": { +"description": "Required. The AlloyDB database to connect to.", +"type": "string" +}, +"enablePsvs": { +"description": "Optional. If true, enable PSVS for AlloyDB.", +"type": "boolean" +}, +"instance": { +"description": "Required. The AlloyDB instance to connect to.", +"type": "string" +}, +"password": { +"description": "Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user.", +"type": "string" +}, +"user": { +"description": "Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigNotebooklmConfig": { +"description": "Config for connecting to NotebookLM Enterprise.", +"id": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigNotebooklmConfig", +"properties": { +"searchConfig": { +"description": "Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/*", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigThirdPartyOauthConfig": { +"description": "Stores information for third party applicationOAuth.", +"id": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigThirdPartyOauthConfig", +"properties": { +"appName": { +"description": "Optional. The type of the application. E.g., \"jira\", \"box\", etc.", +"type": "string" +}, +"instanceName": { +"description": "Optional. The instance name identifying the 3P app, e.g., \"vaissptbots-my\". This is different from the instance_uri which is the full URL of the 3P app e.g., \"https://vaissptbots-my.sharepoint.com\".", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore": { "description": "Stores information regarding the serving configurations at DataStore level.", "id": "GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore", @@ -31992,7 +32423,7 @@ false "type": "string" }, "session": { -"description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", +"description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call.", "type": "string" }, "sessionSpec": { @@ -32710,7 +33141,7 @@ false "type": "object" }, "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec": { -"description": "Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", +"description": "Session specification.", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec", "properties": { "queryId": { @@ -33071,7 +33502,7 @@ false "type": "string" }, "userId": { -"description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json index 98f954fd68..0d635dab92 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json @@ -12250,7 +12250,7 @@ } } }, -"revision": "20260226", +"revision": "20260301", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -12709,6 +12709,27 @@ "useStaticSecrets": { "description": "Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored.", "type": "boolean" +}, +"userDefinedScopesMapping": { +"additionalProperties": { +"$ref": "GoogleCloudDiscoveryengineV1ActionConfigScopeList" +}, +"description": "Optional. Mapping from operation name to the list of scopes. Only be populated if there are user specified scopes.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1ActionConfigScopeList": { +"description": "Stores a list of scopes.", +"id": "GoogleCloudDiscoveryengineV1ActionConfigScopeList", +"properties": { +"scopes": { +"description": "Optional. The list of scopes.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" @@ -13757,7 +13778,7 @@ "type": "string" }, "dataSource": { -"description": "Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`.", +"description": "Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk`", "type": "string" }, "destinationConfigs": { @@ -14195,6 +14216,10 @@ "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", "description": "Configuration for Document understanding and enrichment." }, +"federatedSearchConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfig", +"description": "Optional. If set, this DataStore is a federated search DataStore." +}, "healthcareFhirConfig": { "$ref": "GoogleCloudDiscoveryengineV1HealthcareFhirConfig", "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." @@ -14310,6 +14335,125 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfig": { +"description": "Stores information for federated search.", +"id": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfig", +"properties": { +"alloyDbConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfig", +"description": "AlloyDB config. If set, this DataStore is connected to AlloyDB." +}, +"notebooklmConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigNotebooklmConfig", +"description": "NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise." +}, +"thirdPartyOauthConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigThirdPartyOauthConfig", +"description": "Third Party OAuth config. If set, this DataStore is connected to a third party application." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfig": { +"description": "Stores information for connecting to AlloyDB.", +"id": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfig", +"properties": { +"alloydbAiNlConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig", +"description": "Optional. Configuration for Magic." +}, +"alloydbConnectionConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig", +"description": "Required. Configuration for connecting to AlloyDB." +}, +"returnedFields": { +"description": "Optional. Fields to be returned in the search results. If empty, all fields will be returned.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig": { +"description": "Configuration for AlloyDB AI Natural Language.", +"id": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig", +"properties": { +"nlConfigId": { +"description": "Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig": { +"description": "Configuration for connecting to AlloyDB.", +"id": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig", +"properties": { +"authMode": { +"description": "Optional. Auth mode.", +"enum": [ +"AUTH_MODE_UNSPECIFIED", +"AUTH_MODE_SERVICE_ACCOUNT", +"AUTH_MODE_END_USER_ACCOUNT" +], +"enumDescriptions": [ +"", +"Uses P4SA when VAIS talks to AlloyDB.", +"Uses EUC when VAIS talks to AlloyDB." +], +"type": "string" +}, +"database": { +"description": "Required. The AlloyDB database to connect to.", +"type": "string" +}, +"enablePsvs": { +"description": "Optional. If true, enable PSVS for AlloyDB.", +"type": "boolean" +}, +"instance": { +"description": "Required. The AlloyDB instance to connect to.", +"type": "string" +}, +"password": { +"description": "Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user.", +"type": "string" +}, +"user": { +"description": "Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigNotebooklmConfig": { +"description": "Config for connecting to NotebookLM Enterprise.", +"id": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigNotebooklmConfig", +"properties": { +"searchConfig": { +"description": "Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/*", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigThirdPartyOauthConfig": { +"description": "Stores information for third party applicationOAuth.", +"id": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigThirdPartyOauthConfig", +"properties": { +"appName": { +"description": "Optional. The type of the application. E.g., \"jira\", \"box\", etc.", +"type": "string" +}, +"instanceName": { +"description": "Optional. The instance name identifying the 3P app, e.g., \"vaissptbots-my\". This is different from the instance_uri which is the full URL of the 3P app e.g., \"https://vaissptbots-my.sharepoint.com\".", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore": { "description": "Stores information regarding the serving configurations at DataStore level.", "id": "GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore", @@ -16892,6 +17036,27 @@ "useStaticSecrets": { "description": "Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored.", "type": "boolean" +}, +"userDefinedScopesMapping": { +"additionalProperties": { +"$ref": "GoogleCloudDiscoveryengineV1alphaActionConfigScopeList" +}, +"description": "Optional. Mapping from operation name to the list of scopes. Only be populated if there are user specified scopes.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaActionConfigScopeList": { +"description": "Stores a list of scopes.", +"id": "GoogleCloudDiscoveryengineV1alphaActionConfigScopeList", +"properties": { +"scopes": { +"description": "Optional. The list of scopes.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" @@ -18580,6 +18745,14 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", "description": "Chunk information." }, +"queries": { +"description": "Output only. The search queries that produced this reference.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "structuredDocumentInfo": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo", "description": "Structured document information." @@ -21997,7 +22170,7 @@ "description": "Optional. Specifies the data protection policy for the connector." }, "dataSource": { -"description": "Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`.", +"description": "Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk`", "type": "string" }, "destinationConfigs": { @@ -22457,6 +22630,10 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", "description": "Configuration for Document understanding and enrichment." }, +"federatedSearchConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfig", +"description": "Optional. If set, this DataStore is a federated search DataStore." +}, "healthcareFhirConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig", "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." @@ -22581,6 +22758,125 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfig": { +"description": "Stores information for federated search.", +"id": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfig", +"properties": { +"alloyDbConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfig", +"description": "AlloyDB config. If set, this DataStore is connected to AlloyDB." +}, +"notebooklmConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigNotebooklmConfig", +"description": "NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise." +}, +"thirdPartyOauthConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigThirdPartyOauthConfig", +"description": "Third Party OAuth config. If set, this DataStore is connected to a third party application." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfig": { +"description": "Stores information for connecting to AlloyDB.", +"id": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfig", +"properties": { +"alloydbAiNlConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig", +"description": "Optional. Configuration for Magic." +}, +"alloydbConnectionConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig", +"description": "Required. Configuration for connecting to AlloyDB." +}, +"returnedFields": { +"description": "Optional. Fields to be returned in the search results. If empty, all fields will be returned.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig": { +"description": "Configuration for AlloyDB AI Natural Language.", +"id": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig", +"properties": { +"nlConfigId": { +"description": "Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig": { +"description": "Configuration for connecting to AlloyDB.", +"id": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig", +"properties": { +"authMode": { +"description": "Optional. Auth mode.", +"enum": [ +"AUTH_MODE_UNSPECIFIED", +"AUTH_MODE_SERVICE_ACCOUNT", +"AUTH_MODE_END_USER_ACCOUNT" +], +"enumDescriptions": [ +"", +"Uses P4SA when VAIS talks to AlloyDB.", +"Uses EUC when VAIS talks to AlloyDB." +], +"type": "string" +}, +"database": { +"description": "Required. The AlloyDB database to connect to.", +"type": "string" +}, +"enablePsvs": { +"description": "Optional. If true, enable PSVS for AlloyDB.", +"type": "boolean" +}, +"instance": { +"description": "Required. The AlloyDB instance to connect to.", +"type": "string" +}, +"password": { +"description": "Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user.", +"type": "string" +}, +"user": { +"description": "Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigNotebooklmConfig": { +"description": "Config for connecting to NotebookLM Enterprise.", +"id": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigNotebooklmConfig", +"properties": { +"searchConfig": { +"description": "Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/*", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigThirdPartyOauthConfig": { +"description": "Stores information for third party applicationOAuth.", +"id": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigThirdPartyOauthConfig", +"properties": { +"appName": { +"description": "Optional. The type of the application. E.g., \"jira\", \"box\", etc.", +"type": "string" +}, +"instanceName": { +"description": "Optional. The instance name identifying the 3P app, e.g., \"vaissptbots-my\". This is different from the instance_uri which is the full URL of the 3P app e.g., \"https://vaissptbots-my.sharepoint.com\".", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore": { "description": "Stores information regarding the serving configurations at DataStore level.", "id": "GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore", @@ -28388,7 +28684,7 @@ false "type": "string" }, "session": { -"description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", +"description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call.", "type": "string" }, "sessionSpec": { @@ -29110,7 +29406,7 @@ false "type": "object" }, "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec": { -"description": "Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", +"description": "Session specification.", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec", "properties": { "queryId": { @@ -31123,6 +31419,10 @@ false "description": "The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search.", "type": "string" }, +"entity": { +"description": "Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results.", +"type": "string" +}, "eventTime": { "description": "Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened.", "format": "google-datetime", @@ -31205,7 +31505,7 @@ false "type": "string" }, "userId": { -"description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded.", "type": "string" } }, @@ -32938,6 +33238,10 @@ false "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", "description": "Configuration for Document understanding and enrichment." }, +"federatedSearchConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfig", +"description": "Optional. If set, this DataStore is a federated search DataStore." +}, "healthcareFhirConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig", "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." @@ -33057,6 +33361,125 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfig": { +"description": "Stores information for federated search.", +"id": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfig", +"properties": { +"alloyDbConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfig", +"description": "AlloyDB config. If set, this DataStore is connected to AlloyDB." +}, +"notebooklmConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigNotebooklmConfig", +"description": "NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise." +}, +"thirdPartyOauthConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigThirdPartyOauthConfig", +"description": "Third Party OAuth config. If set, this DataStore is connected to a third party application." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfig": { +"description": "Stores information for connecting to AlloyDB.", +"id": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfig", +"properties": { +"alloydbAiNlConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig", +"description": "Optional. Configuration for Magic." +}, +"alloydbConnectionConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig", +"description": "Required. Configuration for connecting to AlloyDB." +}, +"returnedFields": { +"description": "Optional. Fields to be returned in the search results. If empty, all fields will be returned.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig": { +"description": "Configuration for AlloyDB AI Natural Language.", +"id": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig", +"properties": { +"nlConfigId": { +"description": "Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig": { +"description": "Configuration for connecting to AlloyDB.", +"id": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig", +"properties": { +"authMode": { +"description": "Optional. Auth mode.", +"enum": [ +"AUTH_MODE_UNSPECIFIED", +"AUTH_MODE_SERVICE_ACCOUNT", +"AUTH_MODE_END_USER_ACCOUNT" +], +"enumDescriptions": [ +"", +"Uses P4SA when VAIS talks to AlloyDB.", +"Uses EUC when VAIS talks to AlloyDB." +], +"type": "string" +}, +"database": { +"description": "Required. The AlloyDB database to connect to.", +"type": "string" +}, +"enablePsvs": { +"description": "Optional. If true, enable PSVS for AlloyDB.", +"type": "boolean" +}, +"instance": { +"description": "Required. The AlloyDB instance to connect to.", +"type": "string" +}, +"password": { +"description": "Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user.", +"type": "string" +}, +"user": { +"description": "Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigNotebooklmConfig": { +"description": "Config for connecting to NotebookLM Enterprise.", +"id": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigNotebooklmConfig", +"properties": { +"searchConfig": { +"description": "Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/*", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigThirdPartyOauthConfig": { +"description": "Stores information for third party applicationOAuth.", +"id": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigThirdPartyOauthConfig", +"properties": { +"appName": { +"description": "Optional. The type of the application. E.g., \"jira\", \"box\", etc.", +"type": "string" +}, +"instanceName": { +"description": "Optional. The instance name identifying the 3P app, e.g., \"vaissptbots-my\". This is different from the instance_uri which is the full URL of the 3P app e.g., \"https://vaissptbots-my.sharepoint.com\".", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore": { "description": "Stores information regarding the serving configurations at DataStore level.", "id": "GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore", @@ -35193,7 +35616,7 @@ false "type": "string" }, "session": { -"description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", +"description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call.", "type": "string" }, "sessionSpec": { @@ -35911,7 +36334,7 @@ false "type": "object" }, "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec": { -"description": "Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", +"description": "Session specification.", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec", "properties": { "queryId": { @@ -36272,7 +36695,7 @@ false "type": "string" }, "userId": { -"description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json index a11dfa776b..72300e3de6 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json @@ -9167,7 +9167,7 @@ } } }, -"revision": "20260226", +"revision": "20260301", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -9626,6 +9626,27 @@ "useStaticSecrets": { "description": "Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored.", "type": "boolean" +}, +"userDefinedScopesMapping": { +"additionalProperties": { +"$ref": "GoogleCloudDiscoveryengineV1ActionConfigScopeList" +}, +"description": "Optional. Mapping from operation name to the list of scopes. Only be populated if there are user specified scopes.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1ActionConfigScopeList": { +"description": "Stores a list of scopes.", +"id": "GoogleCloudDiscoveryengineV1ActionConfigScopeList", +"properties": { +"scopes": { +"description": "Optional. The list of scopes.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" @@ -10674,7 +10695,7 @@ "type": "string" }, "dataSource": { -"description": "Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`.", +"description": "Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk`", "type": "string" }, "destinationConfigs": { @@ -11112,6 +11133,10 @@ "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", "description": "Configuration for Document understanding and enrichment." }, +"federatedSearchConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfig", +"description": "Optional. If set, this DataStore is a federated search DataStore." +}, "healthcareFhirConfig": { "$ref": "GoogleCloudDiscoveryengineV1HealthcareFhirConfig", "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." @@ -11227,6 +11252,125 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfig": { +"description": "Stores information for federated search.", +"id": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfig", +"properties": { +"alloyDbConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfig", +"description": "AlloyDB config. If set, this DataStore is connected to AlloyDB." +}, +"notebooklmConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigNotebooklmConfig", +"description": "NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise." +}, +"thirdPartyOauthConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigThirdPartyOauthConfig", +"description": "Third Party OAuth config. If set, this DataStore is connected to a third party application." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfig": { +"description": "Stores information for connecting to AlloyDB.", +"id": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfig", +"properties": { +"alloydbAiNlConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig", +"description": "Optional. Configuration for Magic." +}, +"alloydbConnectionConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig", +"description": "Required. Configuration for connecting to AlloyDB." +}, +"returnedFields": { +"description": "Optional. Fields to be returned in the search results. If empty, all fields will be returned.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig": { +"description": "Configuration for AlloyDB AI Natural Language.", +"id": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig", +"properties": { +"nlConfigId": { +"description": "Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig": { +"description": "Configuration for connecting to AlloyDB.", +"id": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig", +"properties": { +"authMode": { +"description": "Optional. Auth mode.", +"enum": [ +"AUTH_MODE_UNSPECIFIED", +"AUTH_MODE_SERVICE_ACCOUNT", +"AUTH_MODE_END_USER_ACCOUNT" +], +"enumDescriptions": [ +"", +"Uses P4SA when VAIS talks to AlloyDB.", +"Uses EUC when VAIS talks to AlloyDB." +], +"type": "string" +}, +"database": { +"description": "Required. The AlloyDB database to connect to.", +"type": "string" +}, +"enablePsvs": { +"description": "Optional. If true, enable PSVS for AlloyDB.", +"type": "boolean" +}, +"instance": { +"description": "Required. The AlloyDB instance to connect to.", +"type": "string" +}, +"password": { +"description": "Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user.", +"type": "string" +}, +"user": { +"description": "Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigNotebooklmConfig": { +"description": "Config for connecting to NotebookLM Enterprise.", +"id": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigNotebooklmConfig", +"properties": { +"searchConfig": { +"description": "Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/*", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigThirdPartyOauthConfig": { +"description": "Stores information for third party applicationOAuth.", +"id": "GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigThirdPartyOauthConfig", +"properties": { +"appName": { +"description": "Optional. The type of the application. E.g., \"jira\", \"box\", etc.", +"type": "string" +}, +"instanceName": { +"description": "Optional. The instance name identifying the 3P app, e.g., \"vaissptbots-my\". This is different from the instance_uri which is the full URL of the 3P app e.g., \"https://vaissptbots-my.sharepoint.com\".", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore": { "description": "Stores information regarding the serving configurations at DataStore level.", "id": "GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore", @@ -13757,6 +13901,27 @@ "useStaticSecrets": { "description": "Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored.", "type": "boolean" +}, +"userDefinedScopesMapping": { +"additionalProperties": { +"$ref": "GoogleCloudDiscoveryengineV1alphaActionConfigScopeList" +}, +"description": "Optional. Mapping from operation name to the list of scopes. Only be populated if there are user specified scopes.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaActionConfigScopeList": { +"description": "Stores a list of scopes.", +"id": "GoogleCloudDiscoveryengineV1alphaActionConfigScopeList", +"properties": { +"scopes": { +"description": "Optional. The list of scopes.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" @@ -14206,6 +14371,14 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", "description": "Chunk information." }, +"queries": { +"description": "Output only. The search queries that produced this reference.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "structuredDocumentInfo": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo", "description": "Structured document information." @@ -15957,7 +16130,7 @@ "description": "Optional. Specifies the data protection policy for the connector." }, "dataSource": { -"description": "Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`.", +"description": "Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk`", "type": "string" }, "destinationConfigs": { @@ -16417,6 +16590,10 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", "description": "Configuration for Document understanding and enrichment." }, +"federatedSearchConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfig", +"description": "Optional. If set, this DataStore is a federated search DataStore." +}, "healthcareFhirConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig", "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." @@ -16541,6 +16718,125 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfig": { +"description": "Stores information for federated search.", +"id": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfig", +"properties": { +"alloyDbConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfig", +"description": "AlloyDB config. If set, this DataStore is connected to AlloyDB." +}, +"notebooklmConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigNotebooklmConfig", +"description": "NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise." +}, +"thirdPartyOauthConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigThirdPartyOauthConfig", +"description": "Third Party OAuth config. If set, this DataStore is connected to a third party application." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfig": { +"description": "Stores information for connecting to AlloyDB.", +"id": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfig", +"properties": { +"alloydbAiNlConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig", +"description": "Optional. Configuration for Magic." +}, +"alloydbConnectionConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig", +"description": "Required. Configuration for connecting to AlloyDB." +}, +"returnedFields": { +"description": "Optional. Fields to be returned in the search results. If empty, all fields will be returned.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig": { +"description": "Configuration for AlloyDB AI Natural Language.", +"id": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig", +"properties": { +"nlConfigId": { +"description": "Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig": { +"description": "Configuration for connecting to AlloyDB.", +"id": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig", +"properties": { +"authMode": { +"description": "Optional. Auth mode.", +"enum": [ +"AUTH_MODE_UNSPECIFIED", +"AUTH_MODE_SERVICE_ACCOUNT", +"AUTH_MODE_END_USER_ACCOUNT" +], +"enumDescriptions": [ +"", +"Uses P4SA when VAIS talks to AlloyDB.", +"Uses EUC when VAIS talks to AlloyDB." +], +"type": "string" +}, +"database": { +"description": "Required. The AlloyDB database to connect to.", +"type": "string" +}, +"enablePsvs": { +"description": "Optional. If true, enable PSVS for AlloyDB.", +"type": "boolean" +}, +"instance": { +"description": "Required. The AlloyDB instance to connect to.", +"type": "string" +}, +"password": { +"description": "Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user.", +"type": "string" +}, +"user": { +"description": "Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigNotebooklmConfig": { +"description": "Config for connecting to NotebookLM Enterprise.", +"id": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigNotebooklmConfig", +"properties": { +"searchConfig": { +"description": "Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/*", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigThirdPartyOauthConfig": { +"description": "Stores information for third party applicationOAuth.", +"id": "GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigThirdPartyOauthConfig", +"properties": { +"appName": { +"description": "Optional. The type of the application. E.g., \"jira\", \"box\", etc.", +"type": "string" +}, +"instanceName": { +"description": "Optional. The instance name identifying the 3P app, e.g., \"vaissptbots-my\". This is different from the instance_uri which is the full URL of the 3P app e.g., \"https://vaissptbots-my.sharepoint.com\".", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore": { "description": "Stores information regarding the serving configurations at DataStore level.", "id": "GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore", @@ -19715,7 +20011,7 @@ false "type": "string" }, "session": { -"description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", +"description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call.", "type": "string" }, "sessionSpec": { @@ -20437,7 +20733,7 @@ false "type": "object" }, "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec": { -"description": "Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", +"description": "Session specification.", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec", "properties": { "queryId": { @@ -20989,7 +21285,7 @@ false "type": "string" }, "userId": { -"description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded.", "type": "string" } }, @@ -22450,6 +22746,14 @@ false "$ref": "GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfo", "description": "Chunk information." }, +"queries": { +"description": "Output only. The search queries that produced this reference.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "structuredDocumentInfo": { "$ref": "GoogleCloudDiscoveryengineV1betaAnswerReferenceStructuredDocumentInfo", "description": "Structured document information." @@ -25028,6 +25332,10 @@ false "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", "description": "Configuration for Document understanding and enrichment." }, +"federatedSearchConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfig", +"description": "Optional. If set, this DataStore is a federated search DataStore." +}, "healthcareFhirConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig", "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical." @@ -25147,6 +25455,125 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfig": { +"description": "Stores information for federated search.", +"id": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfig", +"properties": { +"alloyDbConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfig", +"description": "AlloyDB config. If set, this DataStore is connected to AlloyDB." +}, +"notebooklmConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigNotebooklmConfig", +"description": "NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise." +}, +"thirdPartyOauthConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigThirdPartyOauthConfig", +"description": "Third Party OAuth config. If set, this DataStore is connected to a third party application." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfig": { +"description": "Stores information for connecting to AlloyDB.", +"id": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfig", +"properties": { +"alloydbAiNlConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig", +"description": "Optional. Configuration for Magic." +}, +"alloydbConnectionConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig", +"description": "Required. Configuration for connecting to AlloyDB." +}, +"returnedFields": { +"description": "Optional. Fields to be returned in the search results. If empty, all fields will be returned.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig": { +"description": "Configuration for AlloyDB AI Natural Language.", +"id": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig", +"properties": { +"nlConfigId": { +"description": "Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig": { +"description": "Configuration for connecting to AlloyDB.", +"id": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig", +"properties": { +"authMode": { +"description": "Optional. Auth mode.", +"enum": [ +"AUTH_MODE_UNSPECIFIED", +"AUTH_MODE_SERVICE_ACCOUNT", +"AUTH_MODE_END_USER_ACCOUNT" +], +"enumDescriptions": [ +"", +"Uses P4SA when VAIS talks to AlloyDB.", +"Uses EUC when VAIS talks to AlloyDB." +], +"type": "string" +}, +"database": { +"description": "Required. The AlloyDB database to connect to.", +"type": "string" +}, +"enablePsvs": { +"description": "Optional. If true, enable PSVS for AlloyDB.", +"type": "boolean" +}, +"instance": { +"description": "Required. The AlloyDB instance to connect to.", +"type": "string" +}, +"password": { +"description": "Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user.", +"type": "string" +}, +"user": { +"description": "Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigNotebooklmConfig": { +"description": "Config for connecting to NotebookLM Enterprise.", +"id": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigNotebooklmConfig", +"properties": { +"searchConfig": { +"description": "Required. Search config name. Format: projects/*/locations/global/notebookLmSearchConfigs/*", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigThirdPartyOauthConfig": { +"description": "Stores information for third party applicationOAuth.", +"id": "GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigThirdPartyOauthConfig", +"properties": { +"appName": { +"description": "Optional. The type of the application. E.g., \"jira\", \"box\", etc.", +"type": "string" +}, +"instanceName": { +"description": "Optional. The instance name identifying the 3P app, e.g., \"vaissptbots-my\". This is different from the instance_uri which is the full URL of the 3P app e.g., \"https://vaissptbots-my.sharepoint.com\".", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore": { "description": "Stores information regarding the serving configurations at DataStore level.", "id": "GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore", @@ -29103,7 +29530,7 @@ false "type": "string" }, "session": { -"description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", +"description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call.", "type": "string" }, "sessionSpec": { @@ -29821,7 +30248,7 @@ false "type": "object" }, "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec": { -"description": "Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", +"description": "Session specification.", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec", "properties": { "queryId": { @@ -31630,6 +32057,10 @@ false "description": "The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search.", "type": "string" }, +"entity": { +"description": "Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results.", +"type": "string" +}, "eventTime": { "description": "Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened.", "format": "google-datetime", @@ -31712,7 +32143,7 @@ false "type": "string" }, "userId": { -"description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded.", "type": "string" } }, From 866970307aa9d78289a92524e7159bdb68562d98 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 10 Mar 2026 07:24:05 +0000 Subject: [PATCH 13/31] feat(displayvideo): update the api #### displayvideo:v2 The following keys were added: - schemas.BiddingStrategy.properties.demandGenBid.$ref (Total Keys: 1) - schemas.ConversionCountingConfig.properties.primaryAttributionModelId (Total Keys: 2) - schemas.DemandGenBiddingStrategy (Total Keys: 10) - schemas.DemandGenSettings (Total Keys: 6) - schemas.ImageAsset.properties.assetId (Total Keys: 2) - schemas.KeywordAssignedTargetingOptionDetails.properties.exemptedPolicyNames (Total Keys: 2) - schemas.LineItem.properties.demandGenSettings.$ref (Total Keys: 1) - schemas.ThirdPartyMeasurementConfigs (Total Keys: 10) #### displayvideo:v3 The following keys were added: - resources.advertisers.resources.adGroupAds.methods.create (Total Keys: 13) - resources.advertisers.resources.adGroupAds.methods.delete (Total Keys: 17) - resources.advertisers.resources.adGroupAds.methods.patch (Total Keys: 21) - resources.advertisers.resources.adGroups.methods.bulkEditAssignedTargetingOptions (Total Keys: 13) - resources.advertisers.resources.adGroups.methods.create (Total Keys: 13) - resources.advertisers.resources.adGroups.methods.delete (Total Keys: 17) - resources.advertisers.resources.adGroups.methods.patch (Total Keys: 21) - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.create (Total Keys: 22) - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete (Total Keys: 25) - schemas.AdGroup.properties.adGroupInventoryControl.$ref (Total Keys: 1) - schemas.AdGroupAd.properties.demandGenCarouselAd.$ref (Total Keys: 1) - schemas.AdGroupAd.properties.demandGenImageAd.$ref (Total Keys: 1) - schemas.AdGroupAd.properties.demandGenProductAd.$ref (Total Keys: 1) - schemas.AdGroupAd.properties.demandGenVideoAd.$ref (Total Keys: 1) - schemas.AdGroupInventoryControl (Total Keys: 4) - schemas.BiddingStrategy.properties.demandGenBid.$ref (Total Keys: 1) - schemas.BulkEditAdGroupAssignedTargetingOptionsRequest (Total Keys: 9) - schemas.BulkEditAdGroupAssignedTargetingOptionsResponse (Total Keys: 13) - schemas.CarouselCard (Total Keys: 7) - schemas.ConversionCountingConfig.properties.primaryAttributionModelId (Total Keys: 2) - schemas.DemandGenBiddingStrategy (Total Keys: 10) - schemas.DemandGenCarouselAd (Total Keys: 9) - schemas.DemandGenImageAd (Total Keys: 16) - schemas.DemandGenProductAd (Total Keys: 8) - schemas.DemandGenSettings (Total Keys: 6) - schemas.DemandGenVideoAd (Total Keys: 14) - schemas.ImageAsset.properties.assetId (Total Keys: 2) - schemas.KeywordAssignedTargetingOptionDetails.properties.exemptedPolicyNames (Total Keys: 2) - schemas.LineItem.properties.demandGenSettings.$ref (Total Keys: 1) - schemas.SelectedInventories (Total Keys: 8) #### displayvideo:v4 The following keys were added: - resources.advertisers.resources.adGroupAds.methods.create (Total Keys: 13) - resources.advertisers.resources.adGroupAds.methods.delete (Total Keys: 17) - resources.advertisers.resources.adGroupAds.methods.patch (Total Keys: 21) - resources.advertisers.resources.adGroups.methods.bulkEditAssignedTargetingOptions (Total Keys: 13) - resources.advertisers.resources.adGroups.methods.create (Total Keys: 13) - resources.advertisers.resources.adGroups.methods.delete (Total Keys: 17) - resources.advertisers.resources.adGroups.methods.patch (Total Keys: 21) - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.create (Total Keys: 22) - resources.advertisers.resources.adGroups.resources.targetingTypes.resources.assignedTargetingOptions.methods.delete (Total Keys: 25) - schemas.AdGroup.properties.adGroupInventoryControl.$ref (Total Keys: 1) - schemas.AdGroupAd.properties.demandGenCarouselAd.$ref (Total Keys: 1) - schemas.AdGroupAd.properties.demandGenImageAd.$ref (Total Keys: 1) - schemas.AdGroupAd.properties.demandGenProductAd.$ref (Total Keys: 1) - schemas.AdGroupAd.properties.demandGenVideoAd.$ref (Total Keys: 1) - schemas.AdGroupInventoryControl (Total Keys: 4) - schemas.BiddingStrategy.properties.demandGenBid.$ref (Total Keys: 1) - schemas.BulkEditAdGroupAssignedTargetingOptionsRequest (Total Keys: 9) - schemas.BulkEditAdGroupAssignedTargetingOptionsResponse (Total Keys: 13) - schemas.CarouselCard (Total Keys: 7) - schemas.ConversionCountingConfig.properties.primaryAttributionModelId (Total Keys: 2) - schemas.DemandGenBiddingStrategy (Total Keys: 10) - schemas.DemandGenCarouselAd (Total Keys: 9) - schemas.DemandGenImageAd (Total Keys: 16) - schemas.DemandGenProductAd (Total Keys: 8) - schemas.DemandGenSettings (Total Keys: 6) - schemas.DemandGenVideoAd (Total Keys: 14) - schemas.ImageAsset.properties.assetId (Total Keys: 2) - schemas.KeywordAssignedTargetingOptionDetails.properties.exemptedPolicyNames (Total Keys: 2) - schemas.LineItem.properties.demandGenSettings.$ref (Total Keys: 1) - schemas.SelectedInventories (Total Keys: 8) --- docs/dyn/displayvideo_v2.advertisers.html | 15 +- ...yvideo_v2.advertisers.insertionOrders.html | 36 + ...displayvideo_v2.advertisers.lineItems.html | 311 +- ...rgetingTypes.assignedTargetingOptions.html | 20 +- ...rgetingTypes.assignedTargetingOptions.html | 20 +- ...ideo_v2.advertisers.youtubeAdGroupAds.html | 8 + ...yvideo_v2.advertisers.youtubeAdGroups.html | 5 +- ...rgetingTypes.assignedTargetingOptions.html | 10 +- docs/dyn/displayvideo_v2.partners.html | 10 +- ...rgetingTypes.assignedTargetingOptions.html | 20 +- ...isplayvideo_v3.advertisers.adGroupAds.html | 3070 +++++++++++++++-- .../displayvideo_v3.advertisers.adGroups.html | 767 +++- ...rgetingTypes.assignedTargetingOptions.html | 821 ++++- docs/dyn/displayvideo_v3.advertisers.html | 15 +- ...yvideo_v3.advertisers.insertionOrders.html | 36 + ...displayvideo_v3.advertisers.lineItems.html | 367 +- ...rgetingTypes.assignedTargetingOptions.html | 20 +- ...rgetingTypes.assignedTargetingOptions.html | 20 +- docs/dyn/displayvideo_v3.partners.html | 10 +- ...rgetingTypes.assignedTargetingOptions.html | 20 +- ...isplayvideo_v4.advertisers.adGroupAds.html | 3070 +++++++++++++++-- .../displayvideo_v4.advertisers.adGroups.html | 767 +++- ...rgetingTypes.assignedTargetingOptions.html | 821 ++++- docs/dyn/displayvideo_v4.advertisers.html | 15 +- ...yvideo_v4.advertisers.insertionOrders.html | 36 + ...displayvideo_v4.advertisers.lineItems.html | 367 +- ...rgetingTypes.assignedTargetingOptions.html | 20 +- ...rgetingTypes.assignedTargetingOptions.html | 20 +- docs/dyn/displayvideo_v4.partners.html | 10 +- ...rgetingTypes.assignedTargetingOptions.html | 20 +- .../documents/displayvideo.v2.json | 191 +- .../documents/displayvideo.v3.json | 1816 ++++++++-- .../documents/displayvideo.v4.json | 2062 ++++++++--- 33 files changed, 13265 insertions(+), 1551 deletions(-) diff --git a/docs/dyn/displayvideo_v2.advertisers.html b/docs/dyn/displayvideo_v2.advertisers.html index f49dc7e3a8..a2f494af7b 100644 --- a/docs/dyn/displayvideo_v2.advertisers.html +++ b/docs/dyn/displayvideo_v2.advertisers.html @@ -469,7 +469,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -509,6 +509,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -775,7 +778,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -815,6 +818,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -1232,7 +1238,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1272,6 +1278,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, diff --git a/docs/dyn/displayvideo_v2.advertisers.insertionOrders.html b/docs/dyn/displayvideo_v2.advertisers.insertionOrders.html index c6689aa70f..eab46f6845 100644 --- a/docs/dyn/displayvideo_v2.advertisers.insertionOrders.html +++ b/docs/dyn/displayvideo_v2.advertisers.insertionOrders.html @@ -113,6 +113,12 @@

Method Details

{ # A single insertion order. "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, @@ -206,6 +212,12 @@

Method Details

{ # A single insertion order. "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, @@ -326,6 +338,12 @@

Method Details

{ # A single insertion order. "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, @@ -432,6 +450,12 @@

Method Details

{ # A single insertion order. "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, @@ -545,6 +569,12 @@

Method Details

{ # A single insertion order. "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, @@ -639,6 +669,12 @@

Method Details

{ # A single insertion order. "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, diff --git a/docs/dyn/displayvideo_v2.advertisers.lineItems.html b/docs/dyn/displayvideo_v2.advertisers.lineItems.html index 3da5030708..e025568a66 100644 --- a/docs/dyn/displayvideo_v2.advertisers.lineItems.html +++ b/docs/dyn/displayvideo_v2.advertisers.lineItems.html @@ -233,7 +233,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -273,6 +273,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -583,7 +586,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -623,6 +626,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -798,6 +804,12 @@

Method Details

"targetLineItem": { # A single line item. # Required. A line item object containing the fields to be updated and the new values to assign to all line items specified in line_item_ids." "advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, @@ -815,7 +827,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -830,10 +842,41 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` * `THIRD_PARTY_VENDOR_GEMIUS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + }, + }, "displayName": "A String", # Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`. "excludeNewExchanges": True or False, # Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default. @@ -852,7 +895,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -890,7 +933,7 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. + "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. @@ -1029,6 +1072,12 @@

Method Details

{ # A single line item. "advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, @@ -1046,7 +1095,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -1061,10 +1110,41 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` * `THIRD_PARTY_VENDOR_GEMIUS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + }, + }, "displayName": "A String", # Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`. "excludeNewExchanges": True or False, # Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default. @@ -1083,7 +1163,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -1121,7 +1201,7 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. + "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. @@ -1220,6 +1300,12 @@

Method Details

{ # A single line item. "advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, @@ -1237,7 +1323,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -1252,10 +1338,41 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` * `THIRD_PARTY_VENDOR_GEMIUS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + }, + }, "displayName": "A String", # Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`. "excludeNewExchanges": True or False, # Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default. @@ -1274,7 +1391,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -1312,7 +1429,7 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. + "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. @@ -1466,6 +1583,12 @@

Method Details

{ # A single line item. "advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, @@ -1483,7 +1606,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -1498,10 +1621,41 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` * `THIRD_PARTY_VENDOR_GEMIUS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + }, + }, "displayName": "A String", # Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`. "excludeNewExchanges": True or False, # Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default. @@ -1520,7 +1674,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -1558,7 +1712,7 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. + "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. @@ -1670,6 +1824,12 @@

Method Details

{ # A single line item. "advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, @@ -1687,7 +1847,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -1702,10 +1862,41 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` * `THIRD_PARTY_VENDOR_GEMIUS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + }, + }, "displayName": "A String", # Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`. "excludeNewExchanges": True or False, # Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default. @@ -1724,7 +1915,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -1762,7 +1953,7 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. + "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. @@ -1881,6 +2072,12 @@

Method Details

{ # A single line item. "advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, @@ -1898,7 +2095,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -1913,10 +2110,41 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` * `THIRD_PARTY_VENDOR_GEMIUS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + }, + }, "displayName": "A String", # Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`. "excludeNewExchanges": True or False, # Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default. @@ -1935,7 +2163,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -1973,7 +2201,7 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. + "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. @@ -2073,6 +2301,12 @@

Method Details

{ # A single line item. "advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, @@ -2090,7 +2324,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -2105,10 +2339,41 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` * `THIRD_PARTY_VENDOR_GEMIUS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + }, + }, "displayName": "A String", # Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`. "excludeNewExchanges": True or False, # Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default. @@ -2127,7 +2392,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -2165,7 +2430,7 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. + "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. diff --git a/docs/dyn/displayvideo_v2.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v2.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html index 7098fa9426..8047395645 100644 --- a/docs/dyn/displayvideo_v2.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v2.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html @@ -263,7 +263,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -303,6 +303,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -554,7 +557,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -594,6 +597,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -976,7 +982,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1016,6 +1022,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -1332,7 +1341,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1372,6 +1381,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, diff --git a/docs/dyn/displayvideo_v2.advertisers.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v2.advertisers.targetingTypes.assignedTargetingOptions.html index b70c562165..1f4dab5aa6 100644 --- a/docs/dyn/displayvideo_v2.advertisers.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v2.advertisers.targetingTypes.assignedTargetingOptions.html @@ -262,7 +262,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -302,6 +302,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -553,7 +556,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -593,6 +596,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -973,7 +979,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1013,6 +1019,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -1328,7 +1337,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1368,6 +1377,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, diff --git a/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroupAds.html b/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroupAds.html index 1f765d4a55..13709bd549 100644 --- a/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroupAds.html +++ b/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroupAds.html @@ -132,6 +132,7 @@

Method Details

"actionButtonLabel": "A String", # The text on the call-to-action button. "actionHeadline": "A String", # The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad. + "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. "heightPixels": 42, # The height in pixels. @@ -159,6 +160,7 @@

Method Details

"actionButtonLabel": "A String", # The text on the call-to-action button. "actionHeadline": "A String", # The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad. + "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. "heightPixels": 42, # The height in pixels. @@ -208,6 +210,7 @@

Method Details

"actionButtonLabel": "A String", # The text on the call-to-action button. "actionHeadline": "A String", # The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad. + "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. "heightPixels": 42, # The height in pixels. @@ -245,6 +248,7 @@

Method Details

], "companionBanners": [ # The list of companion banners used by this ad. { # Meta data of an image asset. + "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. "heightPixels": 42, # The height in pixels. @@ -327,6 +331,7 @@

Method Details

"actionButtonLabel": "A String", # The text on the call-to-action button. "actionHeadline": "A String", # The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad. + "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. "heightPixels": 42, # The height in pixels. @@ -354,6 +359,7 @@

Method Details

"actionButtonLabel": "A String", # The text on the call-to-action button. "actionHeadline": "A String", # The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad. + "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. "heightPixels": 42, # The height in pixels. @@ -403,6 +409,7 @@

Method Details

"actionButtonLabel": "A String", # The text on the call-to-action button. "actionHeadline": "A String", # The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad. + "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. "heightPixels": 42, # The height in pixels. @@ -440,6 +447,7 @@

Method Details

], "companionBanners": [ # The list of companion banners used by this ad. { # Meta data of an image asset. + "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. "heightPixels": 42, # The height in pixels. diff --git a/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.html b/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.html index efa0d017ec..67c7fd8a69 100644 --- a/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.html +++ b/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.html @@ -225,7 +225,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -265,6 +265,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, diff --git a/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.targetingTypes.assignedTargetingOptions.html index 77bf8f164b..b69f1750d1 100644 --- a/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.targetingTypes.assignedTargetingOptions.html @@ -263,7 +263,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -303,6 +303,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -619,7 +622,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -659,6 +662,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, diff --git a/docs/dyn/displayvideo_v2.partners.html b/docs/dyn/displayvideo_v2.partners.html index 36a5c4d649..678d5348d5 100644 --- a/docs/dyn/displayvideo_v2.partners.html +++ b/docs/dyn/displayvideo_v2.partners.html @@ -222,7 +222,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -262,6 +262,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -528,7 +531,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -568,6 +571,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, diff --git a/docs/dyn/displayvideo_v2.partners.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v2.partners.targetingTypes.assignedTargetingOptions.html index f84ec3c702..ef6b6a1ed6 100644 --- a/docs/dyn/displayvideo_v2.partners.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v2.partners.targetingTypes.assignedTargetingOptions.html @@ -262,7 +262,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -302,6 +302,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -553,7 +556,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -593,6 +596,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -973,7 +979,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1013,6 +1019,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -1328,7 +1337,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1368,6 +1377,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, diff --git a/docs/dyn/displayvideo_v3.advertisers.adGroupAds.html b/docs/dyn/displayvideo_v3.advertisers.adGroupAds.html index fd5b6a0258..4da31a20b0 100644 --- a/docs/dyn/displayvideo_v3.advertisers.adGroupAds.html +++ b/docs/dyn/displayvideo_v3.advertisers.adGroupAds.html @@ -77,6 +77,12 @@

Instance Methods

close()

Close httplib2 connections.

+

+ create(advertiserId, body=None, x__xgafv=None)

+

Creates an ad group ad.

+

+ delete(advertiserId, adGroupAdId, x__xgafv=None)

+

Deletes an ad group ad.

get(advertiserId, adGroupAdId, x__xgafv=None)

Gets an ad group ad.

@@ -86,6 +92,9 @@

Instance Methods

list_next()

Retrieves the next page of results.

+

+ patch(advertiserId, adGroupAdId, body=None, updateMask=None, x__xgafv=None)

+

Updates an ad group ad.

Method Details

close() @@ -93,21 +102,15 @@

Method Details

- get(advertiserId, adGroupAdId, x__xgafv=None) -
Gets an ad group ad.
+    create(advertiserId, body=None, x__xgafv=None)
+  
Creates an ad group ad.
 
 Args:
-  advertiserId: string, Required. The ID of the advertiser this ad group ad belongs to. (required)
-  adGroupAdId: string, Required. The ID of the ad to fetch. (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
+  advertiserId: string, Output only. The unique ID of the advertiser the ad belongs to. (required)
+  body: object, The request body.
+    The object takes the form of:
 
-    { # A single ad associated with an ad group.
+{ # A single ad associated with an ad group.
   "adGroupAdId": "A String", # Output only. The unique ID of the ad. Assigned by the system.
   "adGroupId": "A String", # Required. The unique ID of the ad group that the ad belongs to.
   "adPolicy": { # A single ad policy associated with an ad group ad. # Output only. The policy approval status of the ad.
@@ -265,6 +268,7 @@ 

Method Details

"actionButtonLabel": "A String", # The text on the call-to-action button. "actionHeadline": "A String", # The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad. + "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. "heightPixels": 42, # The height in pixels. @@ -282,6 +286,196 @@

Method Details

}, }, }, + "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). + "businessName": "A String", # Required. The business name shown on the ad. + "cards": [ # Required. The list of cards shown on the ad. + { # Details for a Demand Gen carousel card. + "callToAction": "A String", # Required. The call-to-action button shown on the card. Must use 10 characters or less. + "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the card on a mobile device. + "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the card. + "headline": "A String", # Required. The headline of the card. + "marketingImage": { # Meta data of an image asset. # Optional. The marketing image shown on the card. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. + }, + "mimeType": "A String", # Output only. MIME type of the image asset. + }, + "portraitMarketingImage": { # Meta data of an image asset. # Optional. The portrait marketing image shown on the card. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. + }, + "mimeType": "A String", # Output only. MIME type of the image asset. + }, + "squareMarketingImage": { # Meta data of an image asset. # Optional. The square marketing image shown on the card. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. + }, + "mimeType": "A String", # Output only. MIME type of the image asset. + }, + }, + ], + "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "a_key": "A String", + }, + "description": "A String", # Required. The description of the ad. + "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. + "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. + "headline": "A String", # Required. The headline of the ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. + }, + "mimeType": "A String", # Output only. MIME type of the image asset. + }, + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. + }, + "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). + "businessName": "A String", # Required. The business name shown on the ad. + "callToAction": "A String", # Required. The call-to-action button shown on the ad. + "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "a_key": "A String", + }, + "descriptions": [ # Required. The list of descriptions shown on the ad. + "A String", + ], + "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the ad on a mobile device. + "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. + "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. + "headlines": [ # Required. The list of headlines shown on the ad. + "A String", + ], + "logoImages": [ # The list of logo images shown on the ad. + { # Meta data of an image asset. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. + }, + "mimeType": "A String", # Output only. MIME type of the image asset. + }, + ], + "marketingImages": [ # The list of marketing images shown on the ad. + { # Meta data of an image asset. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. + }, + "mimeType": "A String", # Output only. MIME type of the image asset. + }, + ], + "portraitMarketingImages": [ # The list of portrait marketing images shown on the ad. + { # Meta data of an image asset. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. + }, + "mimeType": "A String", # Output only. MIME type of the image asset. + }, + ], + "squareMarketingImages": [ # The list of square marketing images shown on the ad. + { # Meta data of an image asset. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. + }, + "mimeType": "A String", # Output only. MIME type of the image asset. + }, + ], + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. + }, + "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). + "businessName": "A String", # Required. The business name shown on the ad. + "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` + "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "a_key": "A String", + }, + "description": "A String", # Required. The description of the ad. + "displayUrlBreadcrumb1": "A String", # Optional. The first piece after the domain in the display URL. + "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL. + "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. + "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. + "headline": "A String", # Required. The headline of the ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. + }, + "mimeType": "A String", # Output only. MIME type of the image asset. + }, + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. + }, + "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). + "businessName": "A String", # Required. The business name shown on the ad. + "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` + "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. + }, + "mimeType": "A String", # Output only. MIME type of the image asset. + }, + "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "a_key": "A String", + }, + "descriptions": [ # Required. The list of descriptions shown on the ad. + "A String", + ], + "displayUrlBreadcrumb1": "A String", # Optional. The first piece after the domain in the display URL. + "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL. + "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the ad on a mobile device. + "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. + "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. + "headlines": [ # Required. The list of headlines shown on the ad. + "A String", + ], + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. + }, + "mimeType": "A String", # Output only. MIME type of the image asset. + }, + "longHeadlines": [ # Required. The list of lone headlines shown on the ad. + "A String", + ], + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. + "videos": [ # Required. The list of YouTube video assets used by this ad. + { # Details of a YouTube video. + "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. + "unavailableReason": "A String", # The reason why the video data is not available. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + }, + ], + }, "displayName": "A String", # Required. The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes. "displayVideoSourceAd": { # The ad sourced from a DV360 creative. # Output only. Details of an ad sourced from a Display & Video 360 creative. "creativeId": "A String", # The ID of the source creative. @@ -292,6 +486,7 @@

Method Details

"actionButtonLabel": "A String", # The text on the call-to-action button. "actionHeadline": "A String", # The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad. + "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. "heightPixels": 42, # The height in pixels. @@ -341,6 +536,7 @@

Method Details

"actionButtonLabel": "A String", # The text on the call-to-action button. "actionHeadline": "A String", # The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad. + "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. "heightPixels": 42, # The height in pixels. @@ -378,6 +574,7 @@

Method Details

], "companionBanners": [ # The list of companion banners used by this ad. { # Meta data of an image asset. + "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. "heightPixels": 42, # The height in pixels. @@ -411,19 +608,8 @@

Method Details

}, ], }, -}
-
- -
- list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists ad group ads.
+}
 
-Args:
-  advertiserId: string, Required. The ID of the advertiser the ads belong to. (required)
-  filter: string, Optional. Allows filtering by ad group ad fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `adGroupId` * `displayName` * `entityStatus` * `adGroupAdId` Examples: * All ad group ads under an ad group: `adGroupId="1234"` * All ad group ads under an ad group with an entityStatus of `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED`: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
-  orderBy: string, Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.
-  pageSize: integer, Optional. Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
-  pageToken: string, Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroupAds` method. If not specified, the first page of results will be returned.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -432,330 +618,2598 @@ 

Method Details

Returns: An object of the form: - { - "adGroupAds": [ # The list of ads. This list will be absent if empty. { # A single ad associated with an ad group. - "adGroupAdId": "A String", # Output only. The unique ID of the ad. Assigned by the system. - "adGroupId": "A String", # Required. The unique ID of the ad group that the ad belongs to. - "adPolicy": { # A single ad policy associated with an ad group ad. # Output only. The policy approval status of the ad. - "adPolicyApprovalStatus": "A String", # The policy approval status of an ad, indicating the approval decision. - "adPolicyReviewStatus": "A String", # The policy review status of an ad, indicating where in the review process the ad is currently. - "adPolicyTopicEntry": [ # The entries for each policy topic identified as relating to the ad. Each entry includes the topic, restriction level, and guidance on how to fix policy issues. - { # An entry describing how an ad has been identified as relating to an ad policy. - "appealInfo": { # Information on how to appeal a policy decision. # Information on how to appeal the policy decision. - "appealFormLink": "A String", # Only available when appeal_type is `APPEAL_FORM`. - "appealType": "A String", # Whether the decision can be appealed through a self-service appeal or an appeal form. + "adGroupAdId": "A String", # Output only. The unique ID of the ad. Assigned by the system. + "adGroupId": "A String", # Required. The unique ID of the ad group that the ad belongs to. + "adPolicy": { # A single ad policy associated with an ad group ad. # Output only. The policy approval status of the ad. + "adPolicyApprovalStatus": "A String", # The policy approval status of an ad, indicating the approval decision. + "adPolicyReviewStatus": "A String", # The policy review status of an ad, indicating where in the review process the ad is currently. + "adPolicyTopicEntry": [ # The entries for each policy topic identified as relating to the ad. Each entry includes the topic, restriction level, and guidance on how to fix policy issues. + { # An entry describing how an ad has been identified as relating to an ad policy. + "appealInfo": { # Information on how to appeal a policy decision. # Information on how to appeal the policy decision. + "appealFormLink": "A String", # Only available when appeal_type is `APPEAL_FORM`. + "appealType": "A String", # Whether the decision can be appealed through a self-service appeal or an appeal form. + }, + "helpCenterLink": "A String", # Ad policy help center link for the policy topic. + "policyDecisionType": "A String", # The source of the policy decision. + "policyEnforcementMeans": "A String", # The policy enforcement means used in the policy review. + "policyLabel": "A String", # Localized label text for policy. Examples include "Trademarks in text", "Contains Alcohol", etc. + "policyTopic": "A String", # The policy topic. Examples include "TRADEMARKS", "ALCOHOL", etc. + "policyTopicConstraints": [ # The serving constraints relevant to the policy decision. + { # Details on ad serving constraints. + "certificateDomainMismatchCountryList": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where the resource's domain is not covered by the certificates associated with it. + "countries": [ # Countries where the ad cannot serve. + { # Represents a country restriction. + "countryCriterionId": "A String", # The country criterion id. + "countryLabel": "A String", # Localized name for the country. May be empty. + }, + ], }, - "helpCenterLink": "A String", # Ad policy help center link for the policy topic. - "policyDecisionType": "A String", # The source of the policy decision. - "policyEnforcementMeans": "A String", # The policy enforcement means used in the policy review. - "policyLabel": "A String", # Localized label text for policy. Examples include "Trademarks in text", "Contains Alcohol", etc. - "policyTopic": "A String", # The policy topic. Examples include "TRADEMARKS", "ALCOHOL", etc. - "policyTopicConstraints": [ # The serving constraints relevant to the policy decision. - { # Details on ad serving constraints. - "certificateDomainMismatchCountryList": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where the resource's domain is not covered by the certificates associated with it. - "countries": [ # Countries where the ad cannot serve. - { # Represents a country restriction. - "countryCriterionId": "A String", # The country criterion id. - "countryLabel": "A String", # Localized name for the country. May be empty. - }, - ], + "certificateMissingCountryList": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where a certificate is required for serving. + "countries": [ # Countries where the ad cannot serve. + { # Represents a country restriction. + "countryCriterionId": "A String", # The country criterion id. + "countryLabel": "A String", # Localized name for the country. May be empty. }, - "certificateMissingCountryList": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where a certificate is required for serving. - "countries": [ # Countries where the ad cannot serve. - { # Represents a country restriction. - "countryCriterionId": "A String", # The country criterion id. - "countryLabel": "A String", # Localized name for the country. May be empty. - }, - ], + ], + }, + "countryConstraint": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where the ad cannot serve. + "countries": [ # Countries where the ad cannot serve. + { # Represents a country restriction. + "countryCriterionId": "A String", # The country criterion id. + "countryLabel": "A String", # Localized name for the country. May be empty. }, - "countryConstraint": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where the ad cannot serve. - "countries": [ # Countries where the ad cannot serve. + ], + }, + "globalCertificateDomainMismatch": { # Certificate is required to serve in any country and the existing certificate does not cover the ad's domain. # Certificate is required to serve in any country and the existing certificate does not cover the ad's domain. + }, + "globalCertificateMissing": { # Certificate is required to serve in any country. # Certificate is required to serve in any country. + }, + "requestCertificateFormLink": "A String", # Link to the form to request a certificate for the constraint. + "resellerConstraint": { # Policy topic was constrained due to disapproval of the website for reseller purposes. # Reseller constraint. + }, + }, + ], + "policyTopicDescription": "A String", # A short summary description of the policy topic. + "policyTopicEvidences": [ # The evidence used in the policy decision. + { # Evidence information used in the policy decision. + "counterfeit": { # Details on the counterfeit enforcement that caused a policy violation. # Counterfeit enforcement that caused a policy violation. + "owners": [ # The content or product owners that made a complaint. + "A String", + ], + }, + "destinationMismatch": { # Details on a mismatch between destination URL types. # A mismatch between the ad destination URLs. + "uriTypes": [ # The set of URLs that do not match. The list can include single or multiple uri types. Example 1: [`DISPLAY_URL`, `FINAL_URL`] means ad display URL does not match with the ad final URL. Example 2: [`FINAL_URL`] means ad final URL did not match the crawled url, which is also considered as destination mismatch. + "A String", + ], + }, + "destinationNotWorking": { # Details for on HTTP or DNS errors related to the ad destination. # Information on HTTP or DNS errors related to the ad destination. + "device": "A String", # The device where visiting the URL resulted in the error. + "dnsErrorType": "A String", # The type of DNS error. + "expandedUri": "A String", # The full URL that didn't work. + "httpErrorCode": "A String", # The HTTP error code. + "lastCheckedTime": "A String", # The last time the error was seen when navigating to URL. + }, + "destinationTextList": { # A list of destination text that violated the policy. # The text in the destination of the ad that is causing a policy violation. + "destinationTexts": [ # Destination text that caused the policy finding. + "A String", + ], + }, + "httpCode": 42, # HTTP code returned when the final URL was crawled. + "languageCode": "A String", # The language the ad was detected to be written in. This field uses IETF language tags, such as "en-US". + "legalRemoval": { # Legal related regulation enforcement, either from DMCA or local legal regulation. # Legal related regulation enforcement that caused a policy violation. + "complaintType": "A String", # The type of complaint causing the legal removal. + "countryRestrictions": [ # The countries restricted due to the legal removal. + { # Represents a country restriction. + "countryCriterionId": "A String", # The country criterion id. + "countryLabel": "A String", # Localized name for the country. May be empty. + }, + ], + "dmca": { # DMCA complaint details. # Details on the DMCA regulation legal removal. + "complainant": "A String", # The entity who made the legal complaint. + }, + "localLegal": { # Local legal regulation details. # Details on the local legal regulation legal removal. + "lawType": "A String", # Type of law for the legal notice. + }, + "restrictedUris": [ # The urls restricted due to the legal removal. + "A String", + ], + }, + "regionalRequirements": { # Trust & Safety (T&S) proactive enforcement for policies meant to address regional requirements. This is considered a Google-owned investigation instead of a regulation notice since it's proactive T&S enforcement. # T&S proactive enforcement that caused a policy violation. + "regionalRequirementsEntries": [ # List of regional requirements. + { # Policy level regional legal violation details. + "countryRestrictions": [ # The countries restricted due to the legal policy. { # Represents a country restriction. "countryCriterionId": "A String", # The country criterion id. "countryLabel": "A String", # Localized name for the country. May be empty. }, ], + "legalPolicy": "A String", # The legal policy that is being violated. }, - "globalCertificateDomainMismatch": { # Certificate is required to serve in any country and the existing certificate does not cover the ad's domain. # Certificate is required to serve in any country and the existing certificate does not cover the ad's domain. - }, - "globalCertificateMissing": { # Certificate is required to serve in any country. # Certificate is required to serve in any country. + ], + }, + "textList": { # A list of fragments of text that violated the policy. # List of evidence found in the text of the ad. + "texts": [ # The fragments of text from the resource that caused the policy finding. + "A String", + ], + }, + "trademark": { # Trademark terms that caused a policy violation. # Trademark terms that caused a policy violation. + "countryRestrictions": [ # Countries where the policy violation is relevant. + { # Represents a country restriction. + "countryCriterionId": "A String", # The country criterion id. + "countryLabel": "A String", # Localized name for the country. May be empty. }, - "requestCertificateFormLink": "A String", # Link to the form to request a certificate for the constraint. - "resellerConstraint": { # Policy topic was constrained due to disapproval of the website for reseller purposes. # Reseller constraint. - }, - }, - ], - "policyTopicDescription": "A String", # A short summary description of the policy topic. - "policyTopicEvidences": [ # The evidence used in the policy decision. - { # Evidence information used in the policy decision. - "counterfeit": { # Details on the counterfeit enforcement that caused a policy violation. # Counterfeit enforcement that caused a policy violation. - "owners": [ # The content or product owners that made a complaint. - "A String", - ], - }, - "destinationMismatch": { # Details on a mismatch between destination URL types. # A mismatch between the ad destination URLs. - "uriTypes": [ # The set of URLs that do not match. The list can include single or multiple uri types. Example 1: [`DISPLAY_URL`, `FINAL_URL`] means ad display URL does not match with the ad final URL. Example 2: [`FINAL_URL`] means ad final URL did not match the crawled url, which is also considered as destination mismatch. - "A String", - ], - }, - "destinationNotWorking": { # Details for on HTTP or DNS errors related to the ad destination. # Information on HTTP or DNS errors related to the ad destination. - "device": "A String", # The device where visiting the URL resulted in the error. - "dnsErrorType": "A String", # The type of DNS error. - "expandedUri": "A String", # The full URL that didn't work. - "httpErrorCode": "A String", # The HTTP error code. - "lastCheckedTime": "A String", # The last time the error was seen when navigating to URL. - }, - "destinationTextList": { # A list of destination text that violated the policy. # The text in the destination of the ad that is causing a policy violation. - "destinationTexts": [ # Destination text that caused the policy finding. - "A String", - ], - }, - "httpCode": 42, # HTTP code returned when the final URL was crawled. - "languageCode": "A String", # The language the ad was detected to be written in. This field uses IETF language tags, such as "en-US". - "legalRemoval": { # Legal related regulation enforcement, either from DMCA or local legal regulation. # Legal related regulation enforcement that caused a policy violation. - "complaintType": "A String", # The type of complaint causing the legal removal. - "countryRestrictions": [ # The countries restricted due to the legal removal. - { # Represents a country restriction. - "countryCriterionId": "A String", # The country criterion id. - "countryLabel": "A String", # Localized name for the country. May be empty. - }, - ], - "dmca": { # DMCA complaint details. # Details on the DMCA regulation legal removal. - "complainant": "A String", # The entity who made the legal complaint. - }, - "localLegal": { # Local legal regulation details. # Details on the local legal regulation legal removal. - "lawType": "A String", # Type of law for the legal notice. - }, - "restrictedUris": [ # The urls restricted due to the legal removal. - "A String", - ], - }, - "regionalRequirements": { # Trust & Safety (T&S) proactive enforcement for policies meant to address regional requirements. This is considered a Google-owned investigation instead of a regulation notice since it's proactive T&S enforcement. # T&S proactive enforcement that caused a policy violation. - "regionalRequirementsEntries": [ # List of regional requirements. - { # Policy level regional legal violation details. - "countryRestrictions": [ # The countries restricted due to the legal policy. - { # Represents a country restriction. - "countryCriterionId": "A String", # The country criterion id. - "countryLabel": "A String", # Localized name for the country. May be empty. - }, - ], - "legalPolicy": "A String", # The legal policy that is being violated. - }, - ], - }, - "textList": { # A list of fragments of text that violated the policy. # List of evidence found in the text of the ad. - "texts": [ # The fragments of text from the resource that caused the policy finding. - "A String", - ], - }, - "trademark": { # Trademark terms that caused a policy violation. # Trademark terms that caused a policy violation. - "countryRestrictions": [ # Countries where the policy violation is relevant. - { # Represents a country restriction. - "countryCriterionId": "A String", # The country criterion id. - "countryLabel": "A String", # Localized name for the country. May be empty. - }, - ], - "owner": "A String", # The trademark content owner. - "term": "A String", # The trademark term. - }, - "websiteList": { # A list of websites that violated the policy. # List of websites linked with the ad. - "websites": [ # Websites that caused the policy finding. - "A String", - ], - }, - }, - ], - "policyTopicType": "A String", # How ad serving will be affected due to the relation to the ad policy topic. + ], + "owner": "A String", # The trademark content owner. + "term": "A String", # The trademark term. + }, + "websiteList": { # A list of websites that violated the policy. # List of websites linked with the ad. + "websites": [ # Websites that caused the policy finding. + "A String", + ], + }, }, ], + "policyTopicType": "A String", # How ad serving will be affected due to the relation to the ad policy topic. }, - "adUrls": [ # Output only. List of URLs used by the ad. - { # Additional URLs related to the ad, including beacons. - "type": "A String", # The type of the Ad URL. - "url": "A String", # The URL string value. - }, - ], - "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad belongs to. - "audioAd": { # Details for an audio ad. # Output only. Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives. - "displayUrl": "A String", # The webpage address that appears with the ad. - "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. - "video": { # Details of a YouTube video. # The YouTube video of the ad. - "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. - "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + ], + }, + "adUrls": [ # Output only. List of URLs used by the ad. + { # Additional URLs related to the ad, including beacons. + "type": "A String", # The type of the Ad URL. + "url": "A String", # The URL string value. + }, + ], + "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad belongs to. + "audioAd": { # Details for an audio ad. # Output only. Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives. + "displayUrl": "A String", # The webpage address that appears with the ad. + "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad. + "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. + "video": { # Details of a YouTube video. # The YouTube video of the ad. + "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. + "unavailableReason": "A String", # The reason why the video data is not available. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + }, + }, + "bumperAd": { # Details for a bumper ad. # Output only. Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach. + "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes. + "actionButtonLabel": "A String", # The text on the call-to-action button. + "actionHeadline": "A String", # The headline of the call-to-action banner. + "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. }, + "mimeType": "A String", # Output only. MIME type of the image asset. }, - "bumperAd": { # Details for a bumper ad. # Output only. Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach. - "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes. - "actionButtonLabel": "A String", # The text on the call-to-action button. - "actionHeadline": "A String", # The headline of the call-to-action banner. - "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad. - "fileSize": "A String", # Output only. File size of the image asset in bytes. - "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. - "heightPixels": 42, # The height in pixels. - "widthPixels": 42, # The width in pixels. - }, - "mimeType": "A String", # Output only. MIME type of the image asset. + "displayUrl": "A String", # The webpage address that appears with the ad. + "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad. + "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. + "video": { # Details of a YouTube video. # The YouTube video of the ad. + "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. + "unavailableReason": "A String", # The reason why the video data is not available. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + }, + }, + }, + "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). + "businessName": "A String", # Required. The business name shown on the ad. + "cards": [ # Required. The list of cards shown on the ad. + { # Details for a Demand Gen carousel card. + "callToAction": "A String", # Required. The call-to-action button shown on the card. Must use 10 characters or less. + "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the card on a mobile device. + "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the card. + "headline": "A String", # Required. The headline of the card. + "marketingImage": { # Meta data of an image asset. # Optional. The marketing image shown on the card. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. }, - "displayUrl": "A String", # The webpage address that appears with the ad. - "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. - "video": { # Details of a YouTube video. # The YouTube video of the ad. - "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. - "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "mimeType": "A String", # Output only. MIME type of the image asset. + }, + "portraitMarketingImage": { # Meta data of an image asset. # Optional. The portrait marketing image shown on the card. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. + }, + "mimeType": "A String", # Output only. MIME type of the image asset. + }, + "squareMarketingImage": { # Meta data of an image asset. # Optional. The square marketing image shown on the card. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. }, + "mimeType": "A String", # Output only. MIME type of the image asset. }, }, - "displayName": "A String", # Required. The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes. - "displayVideoSourceAd": { # The ad sourced from a DV360 creative. # Output only. Details of an ad sourced from a Display & Video 360 creative. - "creativeId": "A String", # The ID of the source creative. + ], + "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "a_key": "A String", + }, + "description": "A String", # Required. The description of the ad. + "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. + "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. + "headline": "A String", # Required. The headline of the ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. }, - "entityStatus": "A String", # Required. The entity status of the ad. - "inStreamAd": { # Details for an in-stream ad. # Output only. Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives. - "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes. - "actionButtonLabel": "A String", # The text on the call-to-action button. - "actionHeadline": "A String", # The headline of the call-to-action banner. - "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad. - "fileSize": "A String", # Output only. File size of the image asset in bytes. - "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. - "heightPixels": 42, # The height in pixels. - "widthPixels": 42, # The width in pixels. - }, - "mimeType": "A String", # Output only. MIME type of the image asset. - }, - "displayUrl": "A String", # The webpage address that appears with the ad. - "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. - "video": { # Details of a YouTube video. # The YouTube video of the ad. - "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. - "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. - }, + "mimeType": "A String", # Output only. MIME type of the image asset. + }, + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. + }, + "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). + "businessName": "A String", # Required. The business name shown on the ad. + "callToAction": "A String", # Required. The call-to-action button shown on the ad. + "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "a_key": "A String", + }, + "descriptions": [ # Required. The list of descriptions shown on the ad. + "A String", + ], + "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the ad on a mobile device. + "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. + "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. + "headlines": [ # Required. The list of headlines shown on the ad. + "A String", + ], + "logoImages": [ # The list of logo images shown on the ad. + { # Meta data of an image asset. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. }, - "customParameters": { # The custom parameters to pass custom values to tracking URL template. - "a_key": "A String", + "mimeType": "A String", # Output only. MIME type of the image asset. + }, + ], + "marketingImages": [ # The list of marketing images shown on the ad. + { # Meta data of an image asset. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. }, + "mimeType": "A String", # Output only. MIME type of the image asset. }, - "mastheadAd": { # Details for a Masthead Ad. # Output only. Details of an [ad served on the YouTube Home feed](//support.google.com/google-ads/answer/9709826). - "autoplayVideoDuration": "A String", # The duration of time the video will autoplay. - "autoplayVideoStartMillisecond": "A String", # The amount of time in milliseconds after which the video will start to play. - "callToActionButtonLabel": "A String", # The text on the call-to-action button. - "callToActionFinalUrl": "A String", # The destination URL for the call-to-action button. - "callToActionTrackingUrl": "A String", # The tracking URL for the call-to-action button. - "companionYoutubeVideos": [ # The videos that appear next to the Masthead Ad on desktop. Can be no more than two. - { # Details of a YouTube video. - "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. - "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. - }, - ], - "description": "A String", # The description of the ad. - "headline": "A String", # The headline of the ad. - "showChannelArt": True or False, # Whether to show a background or banner that appears at the top of a YouTube page. - "video": { # Details of a YouTube video. # The YouTube video used by the ad. - "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. - "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + ], + "portraitMarketingImages": [ # The list of portrait marketing images shown on the ad. + { # Meta data of an image asset. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. }, - "videoAspectRatio": "A String", # The aspect ratio of the autoplaying YouTube video on the Masthead. + "mimeType": "A String", # Output only. MIME type of the image asset. }, - "name": "A String", # Output only. The resource name of the ad. - "nonSkippableAd": { # Details for a non-skippable ad. # Output only. Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives. - "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes. - "actionButtonLabel": "A String", # The text on the call-to-action button. - "actionHeadline": "A String", # The headline of the call-to-action banner. - "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad. - "fileSize": "A String", # Output only. File size of the image asset in bytes. - "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. - "heightPixels": 42, # The height in pixels. - "widthPixels": 42, # The width in pixels. - }, - "mimeType": "A String", # Output only. MIME type of the image asset. - }, - "displayUrl": "A String", # The webpage address that appears with the ad. - "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. - "video": { # Details of a YouTube video. # The YouTube video of the ad. - "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. - "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. - }, + ], + "squareMarketingImages": [ # The list of square marketing images shown on the ad. + { # Meta data of an image asset. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. }, - "customParameters": { # The custom parameters to pass custom values to tracking URL template. - "a_key": "A String", + "mimeType": "A String", # Output only. MIME type of the image asset. + }, + ], + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. + }, + "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). + "businessName": "A String", # Required. The business name shown on the ad. + "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` + "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "a_key": "A String", + }, + "description": "A String", # Required. The description of the ad. + "displayUrlBreadcrumb1": "A String", # Optional. The first piece after the domain in the display URL. + "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL. + "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. + "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. + "headline": "A String", # Required. The headline of the ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. + }, + "mimeType": "A String", # Output only. MIME type of the image asset. + }, + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. + }, + "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). + "businessName": "A String", # Required. The business name shown on the ad. + "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` + "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. + }, + "mimeType": "A String", # Output only. MIME type of the image asset. + }, + "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "a_key": "A String", + }, + "descriptions": [ # Required. The list of descriptions shown on the ad. + "A String", + ], + "displayUrlBreadcrumb1": "A String", # Optional. The first piece after the domain in the display URL. + "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL. + "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the ad on a mobile device. + "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. + "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. + "headlines": [ # Required. The list of headlines shown on the ad. + "A String", + ], + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. + }, + "mimeType": "A String", # Output only. MIME type of the image asset. + }, + "longHeadlines": [ # Required. The list of lone headlines shown on the ad. + "A String", + ], + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. + "videos": [ # Required. The list of YouTube video assets used by this ad. + { # Details of a YouTube video. + "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. + "unavailableReason": "A String", # The reason why the video data is not available. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + }, + ], + }, + "displayName": "A String", # Required. The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes. + "displayVideoSourceAd": { # The ad sourced from a DV360 creative. # Output only. Details of an ad sourced from a Display & Video 360 creative. + "creativeId": "A String", # The ID of the source creative. + }, + "entityStatus": "A String", # Required. The entity status of the ad. + "inStreamAd": { # Details for an in-stream ad. # Output only. Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives. + "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes. + "actionButtonLabel": "A String", # The text on the call-to-action button. + "actionHeadline": "A String", # The headline of the call-to-action banner. + "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. }, + "mimeType": "A String", # Output only. MIME type of the image asset. }, - "videoDiscoverAd": { # Details for a video discovery ad. # Output only. Details of an [ad promoting a video](//support.google.com/displayvideo/answer/6274216) that shows in places of discovery. - "description1": "A String", # First text line for the ad. - "description2": "A String", # Second text line for the ad. - "headline": "A String", # The headline of ad. - "thumbnail": "A String", # Thumbnail image used in the ad. - "video": { # Details of a YouTube video. # The YouTube video the ad promotes. - "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. - "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "displayUrl": "A String", # The webpage address that appears with the ad. + "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad. + "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. + "video": { # Details of a YouTube video. # The YouTube video of the ad. + "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. + "unavailableReason": "A String", # The reason why the video data is not available. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + }, + }, + "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "a_key": "A String", + }, + }, + "mastheadAd": { # Details for a Masthead Ad. # Output only. Details of an [ad served on the YouTube Home feed](//support.google.com/google-ads/answer/9709826). + "autoplayVideoDuration": "A String", # The duration of time the video will autoplay. + "autoplayVideoStartMillisecond": "A String", # The amount of time in milliseconds after which the video will start to play. + "callToActionButtonLabel": "A String", # The text on the call-to-action button. + "callToActionFinalUrl": "A String", # The destination URL for the call-to-action button. + "callToActionTrackingUrl": "A String", # The tracking URL for the call-to-action button. + "companionYoutubeVideos": [ # The videos that appear next to the Masthead Ad on desktop. Can be no more than two. + { # Details of a YouTube video. + "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. + "unavailableReason": "A String", # The reason why the video data is not available. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + }, + ], + "description": "A String", # The description of the ad. + "headline": "A String", # The headline of the ad. + "showChannelArt": True or False, # Whether to show a background or banner that appears at the top of a YouTube page. + "video": { # Details of a YouTube video. # The YouTube video used by the ad. + "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. + "unavailableReason": "A String", # The reason why the video data is not available. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + }, + "videoAspectRatio": "A String", # The aspect ratio of the autoplaying YouTube video on the Masthead. + }, + "name": "A String", # Output only. The resource name of the ad. + "nonSkippableAd": { # Details for a non-skippable ad. # Output only. Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives. + "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes. + "actionButtonLabel": "A String", # The text on the call-to-action button. + "actionHeadline": "A String", # The headline of the call-to-action banner. + "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. }, + "mimeType": "A String", # Output only. MIME type of the image asset. }, - "videoPerformanceAd": { # Details for a video performance ad. # Output only. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product. - "actionButtonLabels": [ # The list of text assets shown on the call-to-action button. - "A String", - ], - "companionBanners": [ # The list of companion banners used by this ad. - { # Meta data of an image asset. - "fileSize": "A String", # Output only. File size of the image asset in bytes. - "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. - "heightPixels": 42, # The height in pixels. - "widthPixels": 42, # The width in pixels. - }, - "mimeType": "A String", # Output only. MIME type of the image asset. - }, - ], - "customParameters": { # The custom parameters to pass custom values to tracking URL template. - "a_key": "A String", + "displayUrl": "A String", # The webpage address that appears with the ad. + "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad. + "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. + "video": { # Details of a YouTube video. # The YouTube video of the ad. + "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. + "unavailableReason": "A String", # The reason why the video data is not available. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + }, + }, + "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "a_key": "A String", + }, + }, + "videoDiscoverAd": { # Details for a video discovery ad. # Output only. Details of an [ad promoting a video](//support.google.com/displayvideo/answer/6274216) that shows in places of discovery. + "description1": "A String", # First text line for the ad. + "description2": "A String", # Second text line for the ad. + "headline": "A String", # The headline of ad. + "thumbnail": "A String", # Thumbnail image used in the ad. + "video": { # Details of a YouTube video. # The YouTube video the ad promotes. + "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. + "unavailableReason": "A String", # The reason why the video data is not available. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + }, + }, + "videoPerformanceAd": { # Details for a video performance ad. # Output only. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product. + "actionButtonLabels": [ # The list of text assets shown on the call-to-action button. + "A String", + ], + "companionBanners": [ # The list of companion banners used by this ad. + { # Meta data of an image asset. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. }, - "descriptions": [ # The list of descriptions shown on the call-to-action banner. - "A String", - ], - "displayUrlBreadcrumb1": "A String", # The first piece after the domain in the display URL. - "displayUrlBreadcrumb2": "A String", # The second piece after the domain in the display URL. - "domain": "A String", # The domain of the display URL. - "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad. - "headlines": [ # The list of headlines shown on the call-to-action banner. - "A String", - ], - "longHeadlines": [ # The list of lone headlines shown on the call-to-action banner. - "A String", - ], - "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. - "videos": [ # The list of YouTube video assets used by this ad. - { # Details of a YouTube video. - "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. - "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. - }, - ], + "mimeType": "A String", # Output only. MIME type of the image asset. }, + ], + "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "a_key": "A String", }, - ], - "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAdGroupAds` method to retrieve the next page of results. + "descriptions": [ # The list of descriptions shown on the call-to-action banner. + "A String", + ], + "displayUrlBreadcrumb1": "A String", # The first piece after the domain in the display URL. + "displayUrlBreadcrumb2": "A String", # The second piece after the domain in the display URL. + "domain": "A String", # The domain of the display URL. + "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad. + "headlines": [ # The list of headlines shown on the call-to-action banner. + "A String", + ], + "longHeadlines": [ # The list of lone headlines shown on the call-to-action banner. + "A String", + ], + "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. + "videos": [ # The list of YouTube video assets used by this ad. + { # Details of a YouTube video. + "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. + "unavailableReason": "A String", # The reason why the video data is not available. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + }, + ], + }, }
- list_next() -
Retrieves the next page of results.
+    delete(advertiserId, adGroupAdId, x__xgafv=None)
+  
Deletes an ad group ad.
 
-        Args:
-          previous_request: The request for the previous page. (required)
-          previous_response: The response from the request for the previous page. (required)
+Args:
+  advertiserId: string, Required. The ID of the advertiser the ad belongs to. (required)
+  adGroupAdId: string, Required. The ID of the ad to delete. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
 
-        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.
-        
+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(advertiserId, adGroupAdId, x__xgafv=None) +
Gets an ad group ad.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser this ad group ad belongs to. (required)
+  adGroupAdId: string, Required. The ID of the ad to fetch. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single ad associated with an ad group.
+  "adGroupAdId": "A String", # Output only. The unique ID of the ad. Assigned by the system.
+  "adGroupId": "A String", # Required. The unique ID of the ad group that the ad belongs to.
+  "adPolicy": { # A single ad policy associated with an ad group ad. # Output only. The policy approval status of the ad.
+    "adPolicyApprovalStatus": "A String", # The policy approval status of an ad, indicating the approval decision.
+    "adPolicyReviewStatus": "A String", # The policy review status of an ad, indicating where in the review process the ad is currently.
+    "adPolicyTopicEntry": [ # The entries for each policy topic identified as relating to the ad. Each entry includes the topic, restriction level, and guidance on how to fix policy issues.
+      { # An entry describing how an ad has been identified as relating to an ad policy.
+        "appealInfo": { # Information on how to appeal a policy decision. # Information on how to appeal the policy decision.
+          "appealFormLink": "A String", # Only available when appeal_type is `APPEAL_FORM`.
+          "appealType": "A String", # Whether the decision can be appealed through a self-service appeal or an appeal form.
+        },
+        "helpCenterLink": "A String", # Ad policy help center link for the policy topic.
+        "policyDecisionType": "A String", # The source of the policy decision.
+        "policyEnforcementMeans": "A String", # The policy enforcement means used in the policy review.
+        "policyLabel": "A String", # Localized label text for policy. Examples include "Trademarks in text", "Contains Alcohol", etc.
+        "policyTopic": "A String", # The policy topic. Examples include "TRADEMARKS", "ALCOHOL", etc.
+        "policyTopicConstraints": [ # The serving constraints relevant to the policy decision.
+          { # Details on ad serving constraints.
+            "certificateDomainMismatchCountryList": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where the resource's domain is not covered by the certificates associated with it.
+              "countries": [ # Countries where the ad cannot serve.
+                { # Represents a country restriction.
+                  "countryCriterionId": "A String", # The country criterion id.
+                  "countryLabel": "A String", # Localized name for the country. May be empty.
+                },
+              ],
+            },
+            "certificateMissingCountryList": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where a certificate is required for serving.
+              "countries": [ # Countries where the ad cannot serve.
+                { # Represents a country restriction.
+                  "countryCriterionId": "A String", # The country criterion id.
+                  "countryLabel": "A String", # Localized name for the country. May be empty.
+                },
+              ],
+            },
+            "countryConstraint": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where the ad cannot serve.
+              "countries": [ # Countries where the ad cannot serve.
+                { # Represents a country restriction.
+                  "countryCriterionId": "A String", # The country criterion id.
+                  "countryLabel": "A String", # Localized name for the country. May be empty.
+                },
+              ],
+            },
+            "globalCertificateDomainMismatch": { # Certificate is required to serve in any country and the existing certificate does not cover the ad's domain. # Certificate is required to serve in any country and the existing certificate does not cover the ad's domain.
+            },
+            "globalCertificateMissing": { # Certificate is required to serve in any country. # Certificate is required to serve in any country.
+            },
+            "requestCertificateFormLink": "A String", # Link to the form to request a certificate for the constraint.
+            "resellerConstraint": { # Policy topic was constrained due to disapproval of the website for reseller purposes. # Reseller constraint.
+            },
+          },
+        ],
+        "policyTopicDescription": "A String", # A short summary description of the policy topic.
+        "policyTopicEvidences": [ # The evidence used in the policy decision.
+          { # Evidence information used in the policy decision.
+            "counterfeit": { # Details on the counterfeit enforcement that caused a policy violation. # Counterfeit enforcement that caused a policy violation.
+              "owners": [ # The content or product owners that made a complaint.
+                "A String",
+              ],
+            },
+            "destinationMismatch": { # Details on a mismatch between destination URL types. # A mismatch between the ad destination URLs.
+              "uriTypes": [ # The set of URLs that do not match. The list can include single or multiple uri types. Example 1: [`DISPLAY_URL`, `FINAL_URL`] means ad display URL does not match with the ad final URL. Example 2: [`FINAL_URL`] means ad final URL did not match the crawled url, which is also considered as destination mismatch.
+                "A String",
+              ],
+            },
+            "destinationNotWorking": { # Details for on HTTP or DNS errors related to the ad destination. # Information on HTTP or DNS errors related to the ad destination.
+              "device": "A String", # The device where visiting the URL resulted in the error.
+              "dnsErrorType": "A String", # The type of DNS error.
+              "expandedUri": "A String", # The full URL that didn't work.
+              "httpErrorCode": "A String", # The HTTP error code.
+              "lastCheckedTime": "A String", # The last time the error was seen when navigating to URL.
+            },
+            "destinationTextList": { # A list of destination text that violated the policy. # The text in the destination of the ad that is causing a policy violation.
+              "destinationTexts": [ # Destination text that caused the policy finding.
+                "A String",
+              ],
+            },
+            "httpCode": 42, # HTTP code returned when the final URL was crawled.
+            "languageCode": "A String", # The language the ad was detected to be written in. This field uses IETF language tags, such as "en-US".
+            "legalRemoval": { # Legal related regulation enforcement, either from DMCA or local legal regulation. # Legal related regulation enforcement that caused a policy violation.
+              "complaintType": "A String", # The type of complaint causing the legal removal.
+              "countryRestrictions": [ # The countries restricted due to the legal removal.
+                { # Represents a country restriction.
+                  "countryCriterionId": "A String", # The country criterion id.
+                  "countryLabel": "A String", # Localized name for the country. May be empty.
+                },
+              ],
+              "dmca": { # DMCA complaint details. # Details on the DMCA regulation legal removal.
+                "complainant": "A String", # The entity who made the legal complaint.
+              },
+              "localLegal": { # Local legal regulation details. # Details on the local legal regulation legal removal.
+                "lawType": "A String", # Type of law for the legal notice.
+              },
+              "restrictedUris": [ # The urls restricted due to the legal removal.
+                "A String",
+              ],
+            },
+            "regionalRequirements": { # Trust & Safety (T&S) proactive enforcement for policies meant to address regional requirements. This is considered a Google-owned investigation instead of a regulation notice since it's proactive T&S enforcement. # T&S proactive enforcement that caused a policy violation.
+              "regionalRequirementsEntries": [ # List of regional requirements.
+                { # Policy level regional legal violation details.
+                  "countryRestrictions": [ # The countries restricted due to the legal policy.
+                    { # Represents a country restriction.
+                      "countryCriterionId": "A String", # The country criterion id.
+                      "countryLabel": "A String", # Localized name for the country. May be empty.
+                    },
+                  ],
+                  "legalPolicy": "A String", # The legal policy that is being violated.
+                },
+              ],
+            },
+            "textList": { # A list of fragments of text that violated the policy. # List of evidence found in the text of the ad.
+              "texts": [ # The fragments of text from the resource that caused the policy finding.
+                "A String",
+              ],
+            },
+            "trademark": { # Trademark terms that caused a policy violation. # Trademark terms that caused a policy violation.
+              "countryRestrictions": [ # Countries where the policy violation is relevant.
+                { # Represents a country restriction.
+                  "countryCriterionId": "A String", # The country criterion id.
+                  "countryLabel": "A String", # Localized name for the country. May be empty.
+                },
+              ],
+              "owner": "A String", # The trademark content owner.
+              "term": "A String", # The trademark term.
+            },
+            "websiteList": { # A list of websites that violated the policy. # List of websites linked with the ad.
+              "websites": [ # Websites that caused the policy finding.
+                "A String",
+              ],
+            },
+          },
+        ],
+        "policyTopicType": "A String", # How ad serving will be affected due to the relation to the ad policy topic.
+      },
+    ],
+  },
+  "adUrls": [ # Output only. List of URLs used by the ad.
+    { # Additional URLs related to the ad, including beacons.
+      "type": "A String", # The type of the Ad URL.
+      "url": "A String", # The URL string value.
+    },
+  ],
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad belongs to.
+  "audioAd": { # Details for an audio ad. # Output only. Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives.
+    "displayUrl": "A String", # The webpage address that appears with the ad.
+    "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+    "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+    "video": { # Details of a YouTube video. # The YouTube video of the ad.
+      "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+      "unavailableReason": "A String", # The reason why the video data is not available.
+      "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+    },
+  },
+  "bumperAd": { # Details for a bumper ad. # Output only. Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach.
+    "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
+      "actionButtonLabel": "A String", # The text on the call-to-action button.
+      "actionHeadline": "A String", # The headline of the call-to-action banner.
+      "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+      "displayUrl": "A String", # The webpage address that appears with the ad.
+      "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+      "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+      "video": { # Details of a YouTube video. # The YouTube video of the ad.
+        "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+        "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+      },
+    },
+  },
+  "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd).
+    "businessName": "A String", # Required. The business name shown on the ad.
+    "cards": [ # Required. The list of cards shown on the ad.
+      { # Details for a Demand Gen carousel card.
+        "callToAction": "A String", # Required. The call-to-action button shown on the card. Must use 10 characters or less.
+        "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the card on a mobile device.
+        "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the card.
+        "headline": "A String", # Required. The headline of the card.
+        "marketingImage": { # Meta data of an image asset. # Optional. The marketing image shown on the card.
+          "assetId": "A String", # Required. The unique ID of the asset.
+          "fileSize": "A String", # Output only. File size of the image asset in bytes.
+          "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+            "heightPixels": 42, # The height in pixels.
+            "widthPixels": 42, # The width in pixels.
+          },
+          "mimeType": "A String", # Output only. MIME type of the image asset.
+        },
+        "portraitMarketingImage": { # Meta data of an image asset. # Optional. The portrait marketing image shown on the card.
+          "assetId": "A String", # Required. The unique ID of the asset.
+          "fileSize": "A String", # Output only. File size of the image asset in bytes.
+          "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+            "heightPixels": 42, # The height in pixels.
+            "widthPixels": 42, # The width in pixels.
+          },
+          "mimeType": "A String", # Output only. MIME type of the image asset.
+        },
+        "squareMarketingImage": { # Meta data of an image asset. # Optional. The square marketing image shown on the card.
+          "assetId": "A String", # Required. The unique ID of the asset.
+          "fileSize": "A String", # Output only. File size of the image asset in bytes.
+          "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+            "heightPixels": 42, # The height in pixels.
+            "widthPixels": 42, # The width in pixels.
+          },
+          "mimeType": "A String", # Output only. MIME type of the image asset.
+        },
+      },
+    ],
+    "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+    "description": "A String", # Required. The description of the ad.
+    "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad.
+    "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs.
+    "headline": "A String", # Required. The headline of the ad.
+    "logo": { # Meta data of an image asset. # Required. The logo image used by this ad.
+      "assetId": "A String", # Required. The unique ID of the asset.
+      "fileSize": "A String", # Output only. File size of the image asset in bytes.
+      "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+        "heightPixels": 42, # The height in pixels.
+        "widthPixels": 42, # The width in pixels.
+      },
+      "mimeType": "A String", # Output only. MIME type of the image asset.
+    },
+    "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes.
+    "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually.
+  },
+  "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd).
+    "businessName": "A String", # Required. The business name shown on the ad.
+    "callToAction": "A String", # Required. The call-to-action button shown on the ad.
+    "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+    "descriptions": [ # Required. The list of descriptions shown on the ad.
+      "A String",
+    ],
+    "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the ad on a mobile device.
+    "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad.
+    "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs.
+    "headlines": [ # Required. The list of headlines shown on the ad.
+      "A String",
+    ],
+    "logoImages": [ # The list of logo images shown on the ad.
+      { # Meta data of an image asset.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+    ],
+    "marketingImages": [ # The list of marketing images shown on the ad.
+      { # Meta data of an image asset.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+    ],
+    "portraitMarketingImages": [ # The list of portrait marketing images shown on the ad.
+      { # Meta data of an image asset.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+    ],
+    "squareMarketingImages": [ # The list of square marketing images shown on the ad.
+      { # Meta data of an image asset.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+    ],
+    "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes.
+    "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually.
+  },
+  "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd).
+    "businessName": "A String", # Required. The business name shown on the ad.
+    "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE`
+    "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+    "description": "A String", # Required. The description of the ad.
+    "displayUrlBreadcrumb1": "A String", # Optional. The first piece after the domain in the display URL.
+    "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL.
+    "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad.
+    "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs.
+    "headline": "A String", # Required. The headline of the ad.
+    "logo": { # Meta data of an image asset. # Required. The logo image used by this ad.
+      "assetId": "A String", # Required. The unique ID of the asset.
+      "fileSize": "A String", # Output only. File size of the image asset in bytes.
+      "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+        "heightPixels": 42, # The height in pixels.
+        "widthPixels": 42, # The width in pixels.
+      },
+      "mimeType": "A String", # Output only. MIME type of the image asset.
+    },
+    "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes.
+    "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually.
+  },
+  "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd).
+    "businessName": "A String", # Required. The business name shown on the ad.
+    "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW`
+    "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad.
+      "assetId": "A String", # Required. The unique ID of the asset.
+      "fileSize": "A String", # Output only. File size of the image asset in bytes.
+      "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+        "heightPixels": 42, # The height in pixels.
+        "widthPixels": 42, # The width in pixels.
+      },
+      "mimeType": "A String", # Output only. MIME type of the image asset.
+    },
+    "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+    "descriptions": [ # Required. The list of descriptions shown on the ad.
+      "A String",
+    ],
+    "displayUrlBreadcrumb1": "A String", # Optional. The first piece after the domain in the display URL.
+    "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL.
+    "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the ad on a mobile device.
+    "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad.
+    "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs.
+    "headlines": [ # Required. The list of headlines shown on the ad.
+      "A String",
+    ],
+    "logo": { # Meta data of an image asset. # Required. The logo image used by this ad.
+      "assetId": "A String", # Required. The unique ID of the asset.
+      "fileSize": "A String", # Output only. File size of the image asset in bytes.
+      "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+        "heightPixels": 42, # The height in pixels.
+        "widthPixels": 42, # The width in pixels.
+      },
+      "mimeType": "A String", # Output only. MIME type of the image asset.
+    },
+    "longHeadlines": [ # Required. The list of lone headlines shown on the ad.
+      "A String",
+    ],
+    "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes.
+    "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually.
+    "videos": [ # Required. The list of YouTube video assets used by this ad.
+      { # Details of a YouTube video.
+        "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+        "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+      },
+    ],
+  },
+  "displayName": "A String", # Required. The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes.
+  "displayVideoSourceAd": { # The ad sourced from a DV360 creative. # Output only. Details of an ad sourced from a Display & Video 360 creative.
+    "creativeId": "A String", # The ID of the source creative.
+  },
+  "entityStatus": "A String", # Required. The entity status of the ad.
+  "inStreamAd": { # Details for an in-stream ad. # Output only. Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives.
+    "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
+      "actionButtonLabel": "A String", # The text on the call-to-action button.
+      "actionHeadline": "A String", # The headline of the call-to-action banner.
+      "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+      "displayUrl": "A String", # The webpage address that appears with the ad.
+      "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+      "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+      "video": { # Details of a YouTube video. # The YouTube video of the ad.
+        "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+        "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+      },
+    },
+    "customParameters": { # The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+  },
+  "mastheadAd": { # Details for a Masthead Ad. # Output only. Details of an [ad served on the YouTube Home feed](//support.google.com/google-ads/answer/9709826).
+    "autoplayVideoDuration": "A String", # The duration of time the video will autoplay.
+    "autoplayVideoStartMillisecond": "A String", # The amount of time in milliseconds after which the video will start to play.
+    "callToActionButtonLabel": "A String", # The text on the call-to-action button.
+    "callToActionFinalUrl": "A String", # The destination URL for the call-to-action button.
+    "callToActionTrackingUrl": "A String", # The tracking URL for the call-to-action button.
+    "companionYoutubeVideos": [ # The videos that appear next to the Masthead Ad on desktop. Can be no more than two.
+      { # Details of a YouTube video.
+        "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+        "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+      },
+    ],
+    "description": "A String", # The description of the ad.
+    "headline": "A String", # The headline of the ad.
+    "showChannelArt": True or False, # Whether to show a background or banner that appears at the top of a YouTube page.
+    "video": { # Details of a YouTube video. # The YouTube video used by the ad.
+      "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+      "unavailableReason": "A String", # The reason why the video data is not available.
+      "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+    },
+    "videoAspectRatio": "A String", # The aspect ratio of the autoplaying YouTube video on the Masthead.
+  },
+  "name": "A String", # Output only. The resource name of the ad.
+  "nonSkippableAd": { # Details for a non-skippable ad. # Output only. Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives.
+    "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
+      "actionButtonLabel": "A String", # The text on the call-to-action button.
+      "actionHeadline": "A String", # The headline of the call-to-action banner.
+      "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+      "displayUrl": "A String", # The webpage address that appears with the ad.
+      "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+      "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+      "video": { # Details of a YouTube video. # The YouTube video of the ad.
+        "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+        "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+      },
+    },
+    "customParameters": { # The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+  },
+  "videoDiscoverAd": { # Details for a video discovery ad. # Output only. Details of an [ad promoting a video](//support.google.com/displayvideo/answer/6274216) that shows in places of discovery.
+    "description1": "A String", # First text line for the ad.
+    "description2": "A String", # Second text line for the ad.
+    "headline": "A String", # The headline of ad.
+    "thumbnail": "A String", # Thumbnail image used in the ad.
+    "video": { # Details of a YouTube video. # The YouTube video the ad promotes.
+      "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+      "unavailableReason": "A String", # The reason why the video data is not available.
+      "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+    },
+  },
+  "videoPerformanceAd": { # Details for a video performance ad. # Output only. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product.
+    "actionButtonLabels": [ # The list of text assets shown on the call-to-action button.
+      "A String",
+    ],
+    "companionBanners": [ # The list of companion banners used by this ad.
+      { # Meta data of an image asset.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+    ],
+    "customParameters": { # The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+    "descriptions": [ # The list of descriptions shown on the call-to-action banner.
+      "A String",
+    ],
+    "displayUrlBreadcrumb1": "A String", # The first piece after the domain in the display URL.
+    "displayUrlBreadcrumb2": "A String", # The second piece after the domain in the display URL.
+    "domain": "A String", # The domain of the display URL.
+    "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+    "headlines": [ # The list of headlines shown on the call-to-action banner.
+      "A String",
+    ],
+    "longHeadlines": [ # The list of lone headlines shown on the call-to-action banner.
+      "A String",
+    ],
+    "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+    "videos": [ # The list of YouTube video assets used by this ad.
+      { # Details of a YouTube video.
+        "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+        "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+      },
+    ],
+  },
+}
+
+ +
+ list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists ad group ads.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser the ads belong to. (required)
+  filter: string, Optional. Allows filtering by ad group ad fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `adGroupId` * `displayName` * `entityStatus` * `adGroupAdId` Examples: * All ad group ads under an ad group: `adGroupId="1234"` * All ad group ads under an ad group with an entityStatus of `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED`: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
+  orderBy: string, Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.
+  pageSize: integer, Optional. Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
+  pageToken: string, Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroupAds` method. If not specified, the first page of results 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:
+
+    {
+  "adGroupAds": [ # The list of ads. This list will be absent if empty.
+    { # A single ad associated with an ad group.
+      "adGroupAdId": "A String", # Output only. The unique ID of the ad. Assigned by the system.
+      "adGroupId": "A String", # Required. The unique ID of the ad group that the ad belongs to.
+      "adPolicy": { # A single ad policy associated with an ad group ad. # Output only. The policy approval status of the ad.
+        "adPolicyApprovalStatus": "A String", # The policy approval status of an ad, indicating the approval decision.
+        "adPolicyReviewStatus": "A String", # The policy review status of an ad, indicating where in the review process the ad is currently.
+        "adPolicyTopicEntry": [ # The entries for each policy topic identified as relating to the ad. Each entry includes the topic, restriction level, and guidance on how to fix policy issues.
+          { # An entry describing how an ad has been identified as relating to an ad policy.
+            "appealInfo": { # Information on how to appeal a policy decision. # Information on how to appeal the policy decision.
+              "appealFormLink": "A String", # Only available when appeal_type is `APPEAL_FORM`.
+              "appealType": "A String", # Whether the decision can be appealed through a self-service appeal or an appeal form.
+            },
+            "helpCenterLink": "A String", # Ad policy help center link for the policy topic.
+            "policyDecisionType": "A String", # The source of the policy decision.
+            "policyEnforcementMeans": "A String", # The policy enforcement means used in the policy review.
+            "policyLabel": "A String", # Localized label text for policy. Examples include "Trademarks in text", "Contains Alcohol", etc.
+            "policyTopic": "A String", # The policy topic. Examples include "TRADEMARKS", "ALCOHOL", etc.
+            "policyTopicConstraints": [ # The serving constraints relevant to the policy decision.
+              { # Details on ad serving constraints.
+                "certificateDomainMismatchCountryList": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where the resource's domain is not covered by the certificates associated with it.
+                  "countries": [ # Countries where the ad cannot serve.
+                    { # Represents a country restriction.
+                      "countryCriterionId": "A String", # The country criterion id.
+                      "countryLabel": "A String", # Localized name for the country. May be empty.
+                    },
+                  ],
+                },
+                "certificateMissingCountryList": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where a certificate is required for serving.
+                  "countries": [ # Countries where the ad cannot serve.
+                    { # Represents a country restriction.
+                      "countryCriterionId": "A String", # The country criterion id.
+                      "countryLabel": "A String", # Localized name for the country. May be empty.
+                    },
+                  ],
+                },
+                "countryConstraint": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where the ad cannot serve.
+                  "countries": [ # Countries where the ad cannot serve.
+                    { # Represents a country restriction.
+                      "countryCriterionId": "A String", # The country criterion id.
+                      "countryLabel": "A String", # Localized name for the country. May be empty.
+                    },
+                  ],
+                },
+                "globalCertificateDomainMismatch": { # Certificate is required to serve in any country and the existing certificate does not cover the ad's domain. # Certificate is required to serve in any country and the existing certificate does not cover the ad's domain.
+                },
+                "globalCertificateMissing": { # Certificate is required to serve in any country. # Certificate is required to serve in any country.
+                },
+                "requestCertificateFormLink": "A String", # Link to the form to request a certificate for the constraint.
+                "resellerConstraint": { # Policy topic was constrained due to disapproval of the website for reseller purposes. # Reseller constraint.
+                },
+              },
+            ],
+            "policyTopicDescription": "A String", # A short summary description of the policy topic.
+            "policyTopicEvidences": [ # The evidence used in the policy decision.
+              { # Evidence information used in the policy decision.
+                "counterfeit": { # Details on the counterfeit enforcement that caused a policy violation. # Counterfeit enforcement that caused a policy violation.
+                  "owners": [ # The content or product owners that made a complaint.
+                    "A String",
+                  ],
+                },
+                "destinationMismatch": { # Details on a mismatch between destination URL types. # A mismatch between the ad destination URLs.
+                  "uriTypes": [ # The set of URLs that do not match. The list can include single or multiple uri types. Example 1: [`DISPLAY_URL`, `FINAL_URL`] means ad display URL does not match with the ad final URL. Example 2: [`FINAL_URL`] means ad final URL did not match the crawled url, which is also considered as destination mismatch.
+                    "A String",
+                  ],
+                },
+                "destinationNotWorking": { # Details for on HTTP or DNS errors related to the ad destination. # Information on HTTP or DNS errors related to the ad destination.
+                  "device": "A String", # The device where visiting the URL resulted in the error.
+                  "dnsErrorType": "A String", # The type of DNS error.
+                  "expandedUri": "A String", # The full URL that didn't work.
+                  "httpErrorCode": "A String", # The HTTP error code.
+                  "lastCheckedTime": "A String", # The last time the error was seen when navigating to URL.
+                },
+                "destinationTextList": { # A list of destination text that violated the policy. # The text in the destination of the ad that is causing a policy violation.
+                  "destinationTexts": [ # Destination text that caused the policy finding.
+                    "A String",
+                  ],
+                },
+                "httpCode": 42, # HTTP code returned when the final URL was crawled.
+                "languageCode": "A String", # The language the ad was detected to be written in. This field uses IETF language tags, such as "en-US".
+                "legalRemoval": { # Legal related regulation enforcement, either from DMCA or local legal regulation. # Legal related regulation enforcement that caused a policy violation.
+                  "complaintType": "A String", # The type of complaint causing the legal removal.
+                  "countryRestrictions": [ # The countries restricted due to the legal removal.
+                    { # Represents a country restriction.
+                      "countryCriterionId": "A String", # The country criterion id.
+                      "countryLabel": "A String", # Localized name for the country. May be empty.
+                    },
+                  ],
+                  "dmca": { # DMCA complaint details. # Details on the DMCA regulation legal removal.
+                    "complainant": "A String", # The entity who made the legal complaint.
+                  },
+                  "localLegal": { # Local legal regulation details. # Details on the local legal regulation legal removal.
+                    "lawType": "A String", # Type of law for the legal notice.
+                  },
+                  "restrictedUris": [ # The urls restricted due to the legal removal.
+                    "A String",
+                  ],
+                },
+                "regionalRequirements": { # Trust & Safety (T&S) proactive enforcement for policies meant to address regional requirements. This is considered a Google-owned investigation instead of a regulation notice since it's proactive T&S enforcement. # T&S proactive enforcement that caused a policy violation.
+                  "regionalRequirementsEntries": [ # List of regional requirements.
+                    { # Policy level regional legal violation details.
+                      "countryRestrictions": [ # The countries restricted due to the legal policy.
+                        { # Represents a country restriction.
+                          "countryCriterionId": "A String", # The country criterion id.
+                          "countryLabel": "A String", # Localized name for the country. May be empty.
+                        },
+                      ],
+                      "legalPolicy": "A String", # The legal policy that is being violated.
+                    },
+                  ],
+                },
+                "textList": { # A list of fragments of text that violated the policy. # List of evidence found in the text of the ad.
+                  "texts": [ # The fragments of text from the resource that caused the policy finding.
+                    "A String",
+                  ],
+                },
+                "trademark": { # Trademark terms that caused a policy violation. # Trademark terms that caused a policy violation.
+                  "countryRestrictions": [ # Countries where the policy violation is relevant.
+                    { # Represents a country restriction.
+                      "countryCriterionId": "A String", # The country criterion id.
+                      "countryLabel": "A String", # Localized name for the country. May be empty.
+                    },
+                  ],
+                  "owner": "A String", # The trademark content owner.
+                  "term": "A String", # The trademark term.
+                },
+                "websiteList": { # A list of websites that violated the policy. # List of websites linked with the ad.
+                  "websites": [ # Websites that caused the policy finding.
+                    "A String",
+                  ],
+                },
+              },
+            ],
+            "policyTopicType": "A String", # How ad serving will be affected due to the relation to the ad policy topic.
+          },
+        ],
+      },
+      "adUrls": [ # Output only. List of URLs used by the ad.
+        { # Additional URLs related to the ad, including beacons.
+          "type": "A String", # The type of the Ad URL.
+          "url": "A String", # The URL string value.
+        },
+      ],
+      "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad belongs to.
+      "audioAd": { # Details for an audio ad. # Output only. Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives.
+        "displayUrl": "A String", # The webpage address that appears with the ad.
+        "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+        "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+        "video": { # Details of a YouTube video. # The YouTube video of the ad.
+          "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+          "unavailableReason": "A String", # The reason why the video data is not available.
+          "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+        },
+      },
+      "bumperAd": { # Details for a bumper ad. # Output only. Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach.
+        "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
+          "actionButtonLabel": "A String", # The text on the call-to-action button.
+          "actionHeadline": "A String", # The headline of the call-to-action banner.
+          "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
+            "assetId": "A String", # Required. The unique ID of the asset.
+            "fileSize": "A String", # Output only. File size of the image asset in bytes.
+            "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+              "heightPixels": 42, # The height in pixels.
+              "widthPixels": 42, # The width in pixels.
+            },
+            "mimeType": "A String", # Output only. MIME type of the image asset.
+          },
+          "displayUrl": "A String", # The webpage address that appears with the ad.
+          "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+          "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+          "video": { # Details of a YouTube video. # The YouTube video of the ad.
+            "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+            "unavailableReason": "A String", # The reason why the video data is not available.
+            "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+          },
+        },
+      },
+      "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd).
+        "businessName": "A String", # Required. The business name shown on the ad.
+        "cards": [ # Required. The list of cards shown on the ad.
+          { # Details for a Demand Gen carousel card.
+            "callToAction": "A String", # Required. The call-to-action button shown on the card. Must use 10 characters or less.
+            "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the card on a mobile device.
+            "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the card.
+            "headline": "A String", # Required. The headline of the card.
+            "marketingImage": { # Meta data of an image asset. # Optional. The marketing image shown on the card.
+              "assetId": "A String", # Required. The unique ID of the asset.
+              "fileSize": "A String", # Output only. File size of the image asset in bytes.
+              "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+                "heightPixels": 42, # The height in pixels.
+                "widthPixels": 42, # The width in pixels.
+              },
+              "mimeType": "A String", # Output only. MIME type of the image asset.
+            },
+            "portraitMarketingImage": { # Meta data of an image asset. # Optional. The portrait marketing image shown on the card.
+              "assetId": "A String", # Required. The unique ID of the asset.
+              "fileSize": "A String", # Output only. File size of the image asset in bytes.
+              "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+                "heightPixels": 42, # The height in pixels.
+                "widthPixels": 42, # The width in pixels.
+              },
+              "mimeType": "A String", # Output only. MIME type of the image asset.
+            },
+            "squareMarketingImage": { # Meta data of an image asset. # Optional. The square marketing image shown on the card.
+              "assetId": "A String", # Required. The unique ID of the asset.
+              "fileSize": "A String", # Output only. File size of the image asset in bytes.
+              "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+                "heightPixels": 42, # The height in pixels.
+                "widthPixels": 42, # The width in pixels.
+              },
+              "mimeType": "A String", # Output only. MIME type of the image asset.
+            },
+          },
+        ],
+        "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template.
+          "a_key": "A String",
+        },
+        "description": "A String", # Required. The description of the ad.
+        "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad.
+        "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs.
+        "headline": "A String", # Required. The headline of the ad.
+        "logo": { # Meta data of an image asset. # Required. The logo image used by this ad.
+          "assetId": "A String", # Required. The unique ID of the asset.
+          "fileSize": "A String", # Output only. File size of the image asset in bytes.
+          "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+            "heightPixels": 42, # The height in pixels.
+            "widthPixels": 42, # The width in pixels.
+          },
+          "mimeType": "A String", # Output only. MIME type of the image asset.
+        },
+        "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes.
+        "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually.
+      },
+      "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd).
+        "businessName": "A String", # Required. The business name shown on the ad.
+        "callToAction": "A String", # Required. The call-to-action button shown on the ad.
+        "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template.
+          "a_key": "A String",
+        },
+        "descriptions": [ # Required. The list of descriptions shown on the ad.
+          "A String",
+        ],
+        "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the ad on a mobile device.
+        "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad.
+        "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs.
+        "headlines": [ # Required. The list of headlines shown on the ad.
+          "A String",
+        ],
+        "logoImages": [ # The list of logo images shown on the ad.
+          { # Meta data of an image asset.
+            "assetId": "A String", # Required. The unique ID of the asset.
+            "fileSize": "A String", # Output only. File size of the image asset in bytes.
+            "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+              "heightPixels": 42, # The height in pixels.
+              "widthPixels": 42, # The width in pixels.
+            },
+            "mimeType": "A String", # Output only. MIME type of the image asset.
+          },
+        ],
+        "marketingImages": [ # The list of marketing images shown on the ad.
+          { # Meta data of an image asset.
+            "assetId": "A String", # Required. The unique ID of the asset.
+            "fileSize": "A String", # Output only. File size of the image asset in bytes.
+            "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+              "heightPixels": 42, # The height in pixels.
+              "widthPixels": 42, # The width in pixels.
+            },
+            "mimeType": "A String", # Output only. MIME type of the image asset.
+          },
+        ],
+        "portraitMarketingImages": [ # The list of portrait marketing images shown on the ad.
+          { # Meta data of an image asset.
+            "assetId": "A String", # Required. The unique ID of the asset.
+            "fileSize": "A String", # Output only. File size of the image asset in bytes.
+            "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+              "heightPixels": 42, # The height in pixels.
+              "widthPixels": 42, # The width in pixels.
+            },
+            "mimeType": "A String", # Output only. MIME type of the image asset.
+          },
+        ],
+        "squareMarketingImages": [ # The list of square marketing images shown on the ad.
+          { # Meta data of an image asset.
+            "assetId": "A String", # Required. The unique ID of the asset.
+            "fileSize": "A String", # Output only. File size of the image asset in bytes.
+            "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+              "heightPixels": 42, # The height in pixels.
+              "widthPixels": 42, # The width in pixels.
+            },
+            "mimeType": "A String", # Output only. MIME type of the image asset.
+          },
+        ],
+        "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes.
+        "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually.
+      },
+      "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd).
+        "businessName": "A String", # Required. The business name shown on the ad.
+        "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE`
+        "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template.
+          "a_key": "A String",
+        },
+        "description": "A String", # Required. The description of the ad.
+        "displayUrlBreadcrumb1": "A String", # Optional. The first piece after the domain in the display URL.
+        "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL.
+        "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad.
+        "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs.
+        "headline": "A String", # Required. The headline of the ad.
+        "logo": { # Meta data of an image asset. # Required. The logo image used by this ad.
+          "assetId": "A String", # Required. The unique ID of the asset.
+          "fileSize": "A String", # Output only. File size of the image asset in bytes.
+          "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+            "heightPixels": 42, # The height in pixels.
+            "widthPixels": 42, # The width in pixels.
+          },
+          "mimeType": "A String", # Output only. MIME type of the image asset.
+        },
+        "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes.
+        "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually.
+      },
+      "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd).
+        "businessName": "A String", # Required. The business name shown on the ad.
+        "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW`
+        "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad.
+          "assetId": "A String", # Required. The unique ID of the asset.
+          "fileSize": "A String", # Output only. File size of the image asset in bytes.
+          "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+            "heightPixels": 42, # The height in pixels.
+            "widthPixels": 42, # The width in pixels.
+          },
+          "mimeType": "A String", # Output only. MIME type of the image asset.
+        },
+        "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template.
+          "a_key": "A String",
+        },
+        "descriptions": [ # Required. The list of descriptions shown on the ad.
+          "A String",
+        ],
+        "displayUrlBreadcrumb1": "A String", # Optional. The first piece after the domain in the display URL.
+        "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL.
+        "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the ad on a mobile device.
+        "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad.
+        "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs.
+        "headlines": [ # Required. The list of headlines shown on the ad.
+          "A String",
+        ],
+        "logo": { # Meta data of an image asset. # Required. The logo image used by this ad.
+          "assetId": "A String", # Required. The unique ID of the asset.
+          "fileSize": "A String", # Output only. File size of the image asset in bytes.
+          "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+            "heightPixels": 42, # The height in pixels.
+            "widthPixels": 42, # The width in pixels.
+          },
+          "mimeType": "A String", # Output only. MIME type of the image asset.
+        },
+        "longHeadlines": [ # Required. The list of lone headlines shown on the ad.
+          "A String",
+        ],
+        "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes.
+        "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually.
+        "videos": [ # Required. The list of YouTube video assets used by this ad.
+          { # Details of a YouTube video.
+            "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+            "unavailableReason": "A String", # The reason why the video data is not available.
+            "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+          },
+        ],
+      },
+      "displayName": "A String", # Required. The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes.
+      "displayVideoSourceAd": { # The ad sourced from a DV360 creative. # Output only. Details of an ad sourced from a Display & Video 360 creative.
+        "creativeId": "A String", # The ID of the source creative.
+      },
+      "entityStatus": "A String", # Required. The entity status of the ad.
+      "inStreamAd": { # Details for an in-stream ad. # Output only. Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives.
+        "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
+          "actionButtonLabel": "A String", # The text on the call-to-action button.
+          "actionHeadline": "A String", # The headline of the call-to-action banner.
+          "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
+            "assetId": "A String", # Required. The unique ID of the asset.
+            "fileSize": "A String", # Output only. File size of the image asset in bytes.
+            "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+              "heightPixels": 42, # The height in pixels.
+              "widthPixels": 42, # The width in pixels.
+            },
+            "mimeType": "A String", # Output only. MIME type of the image asset.
+          },
+          "displayUrl": "A String", # The webpage address that appears with the ad.
+          "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+          "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+          "video": { # Details of a YouTube video. # The YouTube video of the ad.
+            "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+            "unavailableReason": "A String", # The reason why the video data is not available.
+            "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+          },
+        },
+        "customParameters": { # The custom parameters to pass custom values to tracking URL template.
+          "a_key": "A String",
+        },
+      },
+      "mastheadAd": { # Details for a Masthead Ad. # Output only. Details of an [ad served on the YouTube Home feed](//support.google.com/google-ads/answer/9709826).
+        "autoplayVideoDuration": "A String", # The duration of time the video will autoplay.
+        "autoplayVideoStartMillisecond": "A String", # The amount of time in milliseconds after which the video will start to play.
+        "callToActionButtonLabel": "A String", # The text on the call-to-action button.
+        "callToActionFinalUrl": "A String", # The destination URL for the call-to-action button.
+        "callToActionTrackingUrl": "A String", # The tracking URL for the call-to-action button.
+        "companionYoutubeVideos": [ # The videos that appear next to the Masthead Ad on desktop. Can be no more than two.
+          { # Details of a YouTube video.
+            "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+            "unavailableReason": "A String", # The reason why the video data is not available.
+            "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+          },
+        ],
+        "description": "A String", # The description of the ad.
+        "headline": "A String", # The headline of the ad.
+        "showChannelArt": True or False, # Whether to show a background or banner that appears at the top of a YouTube page.
+        "video": { # Details of a YouTube video. # The YouTube video used by the ad.
+          "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+          "unavailableReason": "A String", # The reason why the video data is not available.
+          "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+        },
+        "videoAspectRatio": "A String", # The aspect ratio of the autoplaying YouTube video on the Masthead.
+      },
+      "name": "A String", # Output only. The resource name of the ad.
+      "nonSkippableAd": { # Details for a non-skippable ad. # Output only. Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives.
+        "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
+          "actionButtonLabel": "A String", # The text on the call-to-action button.
+          "actionHeadline": "A String", # The headline of the call-to-action banner.
+          "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
+            "assetId": "A String", # Required. The unique ID of the asset.
+            "fileSize": "A String", # Output only. File size of the image asset in bytes.
+            "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+              "heightPixels": 42, # The height in pixels.
+              "widthPixels": 42, # The width in pixels.
+            },
+            "mimeType": "A String", # Output only. MIME type of the image asset.
+          },
+          "displayUrl": "A String", # The webpage address that appears with the ad.
+          "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+          "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+          "video": { # Details of a YouTube video. # The YouTube video of the ad.
+            "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+            "unavailableReason": "A String", # The reason why the video data is not available.
+            "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+          },
+        },
+        "customParameters": { # The custom parameters to pass custom values to tracking URL template.
+          "a_key": "A String",
+        },
+      },
+      "videoDiscoverAd": { # Details for a video discovery ad. # Output only. Details of an [ad promoting a video](//support.google.com/displayvideo/answer/6274216) that shows in places of discovery.
+        "description1": "A String", # First text line for the ad.
+        "description2": "A String", # Second text line for the ad.
+        "headline": "A String", # The headline of ad.
+        "thumbnail": "A String", # Thumbnail image used in the ad.
+        "video": { # Details of a YouTube video. # The YouTube video the ad promotes.
+          "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+          "unavailableReason": "A String", # The reason why the video data is not available.
+          "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+        },
+      },
+      "videoPerformanceAd": { # Details for a video performance ad. # Output only. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product.
+        "actionButtonLabels": [ # The list of text assets shown on the call-to-action button.
+          "A String",
+        ],
+        "companionBanners": [ # The list of companion banners used by this ad.
+          { # Meta data of an image asset.
+            "assetId": "A String", # Required. The unique ID of the asset.
+            "fileSize": "A String", # Output only. File size of the image asset in bytes.
+            "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+              "heightPixels": 42, # The height in pixels.
+              "widthPixels": 42, # The width in pixels.
+            },
+            "mimeType": "A String", # Output only. MIME type of the image asset.
+          },
+        ],
+        "customParameters": { # The custom parameters to pass custom values to tracking URL template.
+          "a_key": "A String",
+        },
+        "descriptions": [ # The list of descriptions shown on the call-to-action banner.
+          "A String",
+        ],
+        "displayUrlBreadcrumb1": "A String", # The first piece after the domain in the display URL.
+        "displayUrlBreadcrumb2": "A String", # The second piece after the domain in the display URL.
+        "domain": "A String", # The domain of the display URL.
+        "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+        "headlines": [ # The list of headlines shown on the call-to-action banner.
+          "A String",
+        ],
+        "longHeadlines": [ # The list of lone headlines shown on the call-to-action banner.
+          "A String",
+        ],
+        "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+        "videos": [ # The list of YouTube video assets used by this ad.
+          { # Details of a YouTube video.
+            "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+            "unavailableReason": "A String", # The reason why the video data is not available.
+            "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+          },
+        ],
+      },
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAdGroupAds` method to retrieve the next page of 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(advertiserId, adGroupAdId, body=None, updateMask=None, x__xgafv=None) +
Updates an ad group ad.
+
+Args:
+  advertiserId: string, Output only. The unique ID of the advertiser the ad belongs to. (required)
+  adGroupAdId: string, Output only. The unique ID of the ad. Assigned by the system. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single ad associated with an ad group.
+  "adGroupAdId": "A String", # Output only. The unique ID of the ad. Assigned by the system.
+  "adGroupId": "A String", # Required. The unique ID of the ad group that the ad belongs to.
+  "adPolicy": { # A single ad policy associated with an ad group ad. # Output only. The policy approval status of the ad.
+    "adPolicyApprovalStatus": "A String", # The policy approval status of an ad, indicating the approval decision.
+    "adPolicyReviewStatus": "A String", # The policy review status of an ad, indicating where in the review process the ad is currently.
+    "adPolicyTopicEntry": [ # The entries for each policy topic identified as relating to the ad. Each entry includes the topic, restriction level, and guidance on how to fix policy issues.
+      { # An entry describing how an ad has been identified as relating to an ad policy.
+        "appealInfo": { # Information on how to appeal a policy decision. # Information on how to appeal the policy decision.
+          "appealFormLink": "A String", # Only available when appeal_type is `APPEAL_FORM`.
+          "appealType": "A String", # Whether the decision can be appealed through a self-service appeal or an appeal form.
+        },
+        "helpCenterLink": "A String", # Ad policy help center link for the policy topic.
+        "policyDecisionType": "A String", # The source of the policy decision.
+        "policyEnforcementMeans": "A String", # The policy enforcement means used in the policy review.
+        "policyLabel": "A String", # Localized label text for policy. Examples include "Trademarks in text", "Contains Alcohol", etc.
+        "policyTopic": "A String", # The policy topic. Examples include "TRADEMARKS", "ALCOHOL", etc.
+        "policyTopicConstraints": [ # The serving constraints relevant to the policy decision.
+          { # Details on ad serving constraints.
+            "certificateDomainMismatchCountryList": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where the resource's domain is not covered by the certificates associated with it.
+              "countries": [ # Countries where the ad cannot serve.
+                { # Represents a country restriction.
+                  "countryCriterionId": "A String", # The country criterion id.
+                  "countryLabel": "A String", # Localized name for the country. May be empty.
+                },
+              ],
+            },
+            "certificateMissingCountryList": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where a certificate is required for serving.
+              "countries": [ # Countries where the ad cannot serve.
+                { # Represents a country restriction.
+                  "countryCriterionId": "A String", # The country criterion id.
+                  "countryLabel": "A String", # Localized name for the country. May be empty.
+                },
+              ],
+            },
+            "countryConstraint": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where the ad cannot serve.
+              "countries": [ # Countries where the ad cannot serve.
+                { # Represents a country restriction.
+                  "countryCriterionId": "A String", # The country criterion id.
+                  "countryLabel": "A String", # Localized name for the country. May be empty.
+                },
+              ],
+            },
+            "globalCertificateDomainMismatch": { # Certificate is required to serve in any country and the existing certificate does not cover the ad's domain. # Certificate is required to serve in any country and the existing certificate does not cover the ad's domain.
+            },
+            "globalCertificateMissing": { # Certificate is required to serve in any country. # Certificate is required to serve in any country.
+            },
+            "requestCertificateFormLink": "A String", # Link to the form to request a certificate for the constraint.
+            "resellerConstraint": { # Policy topic was constrained due to disapproval of the website for reseller purposes. # Reseller constraint.
+            },
+          },
+        ],
+        "policyTopicDescription": "A String", # A short summary description of the policy topic.
+        "policyTopicEvidences": [ # The evidence used in the policy decision.
+          { # Evidence information used in the policy decision.
+            "counterfeit": { # Details on the counterfeit enforcement that caused a policy violation. # Counterfeit enforcement that caused a policy violation.
+              "owners": [ # The content or product owners that made a complaint.
+                "A String",
+              ],
+            },
+            "destinationMismatch": { # Details on a mismatch between destination URL types. # A mismatch between the ad destination URLs.
+              "uriTypes": [ # The set of URLs that do not match. The list can include single or multiple uri types. Example 1: [`DISPLAY_URL`, `FINAL_URL`] means ad display URL does not match with the ad final URL. Example 2: [`FINAL_URL`] means ad final URL did not match the crawled url, which is also considered as destination mismatch.
+                "A String",
+              ],
+            },
+            "destinationNotWorking": { # Details for on HTTP or DNS errors related to the ad destination. # Information on HTTP or DNS errors related to the ad destination.
+              "device": "A String", # The device where visiting the URL resulted in the error.
+              "dnsErrorType": "A String", # The type of DNS error.
+              "expandedUri": "A String", # The full URL that didn't work.
+              "httpErrorCode": "A String", # The HTTP error code.
+              "lastCheckedTime": "A String", # The last time the error was seen when navigating to URL.
+            },
+            "destinationTextList": { # A list of destination text that violated the policy. # The text in the destination of the ad that is causing a policy violation.
+              "destinationTexts": [ # Destination text that caused the policy finding.
+                "A String",
+              ],
+            },
+            "httpCode": 42, # HTTP code returned when the final URL was crawled.
+            "languageCode": "A String", # The language the ad was detected to be written in. This field uses IETF language tags, such as "en-US".
+            "legalRemoval": { # Legal related regulation enforcement, either from DMCA or local legal regulation. # Legal related regulation enforcement that caused a policy violation.
+              "complaintType": "A String", # The type of complaint causing the legal removal.
+              "countryRestrictions": [ # The countries restricted due to the legal removal.
+                { # Represents a country restriction.
+                  "countryCriterionId": "A String", # The country criterion id.
+                  "countryLabel": "A String", # Localized name for the country. May be empty.
+                },
+              ],
+              "dmca": { # DMCA complaint details. # Details on the DMCA regulation legal removal.
+                "complainant": "A String", # The entity who made the legal complaint.
+              },
+              "localLegal": { # Local legal regulation details. # Details on the local legal regulation legal removal.
+                "lawType": "A String", # Type of law for the legal notice.
+              },
+              "restrictedUris": [ # The urls restricted due to the legal removal.
+                "A String",
+              ],
+            },
+            "regionalRequirements": { # Trust & Safety (T&S) proactive enforcement for policies meant to address regional requirements. This is considered a Google-owned investigation instead of a regulation notice since it's proactive T&S enforcement. # T&S proactive enforcement that caused a policy violation.
+              "regionalRequirementsEntries": [ # List of regional requirements.
+                { # Policy level regional legal violation details.
+                  "countryRestrictions": [ # The countries restricted due to the legal policy.
+                    { # Represents a country restriction.
+                      "countryCriterionId": "A String", # The country criterion id.
+                      "countryLabel": "A String", # Localized name for the country. May be empty.
+                    },
+                  ],
+                  "legalPolicy": "A String", # The legal policy that is being violated.
+                },
+              ],
+            },
+            "textList": { # A list of fragments of text that violated the policy. # List of evidence found in the text of the ad.
+              "texts": [ # The fragments of text from the resource that caused the policy finding.
+                "A String",
+              ],
+            },
+            "trademark": { # Trademark terms that caused a policy violation. # Trademark terms that caused a policy violation.
+              "countryRestrictions": [ # Countries where the policy violation is relevant.
+                { # Represents a country restriction.
+                  "countryCriterionId": "A String", # The country criterion id.
+                  "countryLabel": "A String", # Localized name for the country. May be empty.
+                },
+              ],
+              "owner": "A String", # The trademark content owner.
+              "term": "A String", # The trademark term.
+            },
+            "websiteList": { # A list of websites that violated the policy. # List of websites linked with the ad.
+              "websites": [ # Websites that caused the policy finding.
+                "A String",
+              ],
+            },
+          },
+        ],
+        "policyTopicType": "A String", # How ad serving will be affected due to the relation to the ad policy topic.
+      },
+    ],
+  },
+  "adUrls": [ # Output only. List of URLs used by the ad.
+    { # Additional URLs related to the ad, including beacons.
+      "type": "A String", # The type of the Ad URL.
+      "url": "A String", # The URL string value.
+    },
+  ],
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad belongs to.
+  "audioAd": { # Details for an audio ad. # Output only. Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives.
+    "displayUrl": "A String", # The webpage address that appears with the ad.
+    "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+    "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+    "video": { # Details of a YouTube video. # The YouTube video of the ad.
+      "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+      "unavailableReason": "A String", # The reason why the video data is not available.
+      "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+    },
+  },
+  "bumperAd": { # Details for a bumper ad. # Output only. Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach.
+    "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
+      "actionButtonLabel": "A String", # The text on the call-to-action button.
+      "actionHeadline": "A String", # The headline of the call-to-action banner.
+      "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+      "displayUrl": "A String", # The webpage address that appears with the ad.
+      "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+      "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+      "video": { # Details of a YouTube video. # The YouTube video of the ad.
+        "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+        "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+      },
+    },
+  },
+  "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd).
+    "businessName": "A String", # Required. The business name shown on the ad.
+    "cards": [ # Required. The list of cards shown on the ad.
+      { # Details for a Demand Gen carousel card.
+        "callToAction": "A String", # Required. The call-to-action button shown on the card. Must use 10 characters or less.
+        "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the card on a mobile device.
+        "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the card.
+        "headline": "A String", # Required. The headline of the card.
+        "marketingImage": { # Meta data of an image asset. # Optional. The marketing image shown on the card.
+          "assetId": "A String", # Required. The unique ID of the asset.
+          "fileSize": "A String", # Output only. File size of the image asset in bytes.
+          "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+            "heightPixels": 42, # The height in pixels.
+            "widthPixels": 42, # The width in pixels.
+          },
+          "mimeType": "A String", # Output only. MIME type of the image asset.
+        },
+        "portraitMarketingImage": { # Meta data of an image asset. # Optional. The portrait marketing image shown on the card.
+          "assetId": "A String", # Required. The unique ID of the asset.
+          "fileSize": "A String", # Output only. File size of the image asset in bytes.
+          "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+            "heightPixels": 42, # The height in pixels.
+            "widthPixels": 42, # The width in pixels.
+          },
+          "mimeType": "A String", # Output only. MIME type of the image asset.
+        },
+        "squareMarketingImage": { # Meta data of an image asset. # Optional. The square marketing image shown on the card.
+          "assetId": "A String", # Required. The unique ID of the asset.
+          "fileSize": "A String", # Output only. File size of the image asset in bytes.
+          "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+            "heightPixels": 42, # The height in pixels.
+            "widthPixels": 42, # The width in pixels.
+          },
+          "mimeType": "A String", # Output only. MIME type of the image asset.
+        },
+      },
+    ],
+    "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+    "description": "A String", # Required. The description of the ad.
+    "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad.
+    "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs.
+    "headline": "A String", # Required. The headline of the ad.
+    "logo": { # Meta data of an image asset. # Required. The logo image used by this ad.
+      "assetId": "A String", # Required. The unique ID of the asset.
+      "fileSize": "A String", # Output only. File size of the image asset in bytes.
+      "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+        "heightPixels": 42, # The height in pixels.
+        "widthPixels": 42, # The width in pixels.
+      },
+      "mimeType": "A String", # Output only. MIME type of the image asset.
+    },
+    "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes.
+    "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually.
+  },
+  "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd).
+    "businessName": "A String", # Required. The business name shown on the ad.
+    "callToAction": "A String", # Required. The call-to-action button shown on the ad.
+    "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+    "descriptions": [ # Required. The list of descriptions shown on the ad.
+      "A String",
+    ],
+    "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the ad on a mobile device.
+    "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad.
+    "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs.
+    "headlines": [ # Required. The list of headlines shown on the ad.
+      "A String",
+    ],
+    "logoImages": [ # The list of logo images shown on the ad.
+      { # Meta data of an image asset.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+    ],
+    "marketingImages": [ # The list of marketing images shown on the ad.
+      { # Meta data of an image asset.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+    ],
+    "portraitMarketingImages": [ # The list of portrait marketing images shown on the ad.
+      { # Meta data of an image asset.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+    ],
+    "squareMarketingImages": [ # The list of square marketing images shown on the ad.
+      { # Meta data of an image asset.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+    ],
+    "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes.
+    "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually.
+  },
+  "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd).
+    "businessName": "A String", # Required. The business name shown on the ad.
+    "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE`
+    "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+    "description": "A String", # Required. The description of the ad.
+    "displayUrlBreadcrumb1": "A String", # Optional. The first piece after the domain in the display URL.
+    "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL.
+    "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad.
+    "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs.
+    "headline": "A String", # Required. The headline of the ad.
+    "logo": { # Meta data of an image asset. # Required. The logo image used by this ad.
+      "assetId": "A String", # Required. The unique ID of the asset.
+      "fileSize": "A String", # Output only. File size of the image asset in bytes.
+      "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+        "heightPixels": 42, # The height in pixels.
+        "widthPixels": 42, # The width in pixels.
+      },
+      "mimeType": "A String", # Output only. MIME type of the image asset.
+    },
+    "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes.
+    "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually.
+  },
+  "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd).
+    "businessName": "A String", # Required. The business name shown on the ad.
+    "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW`
+    "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad.
+      "assetId": "A String", # Required. The unique ID of the asset.
+      "fileSize": "A String", # Output only. File size of the image asset in bytes.
+      "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+        "heightPixels": 42, # The height in pixels.
+        "widthPixels": 42, # The width in pixels.
+      },
+      "mimeType": "A String", # Output only. MIME type of the image asset.
+    },
+    "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+    "descriptions": [ # Required. The list of descriptions shown on the ad.
+      "A String",
+    ],
+    "displayUrlBreadcrumb1": "A String", # Optional. The first piece after the domain in the display URL.
+    "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL.
+    "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the ad on a mobile device.
+    "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad.
+    "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs.
+    "headlines": [ # Required. The list of headlines shown on the ad.
+      "A String",
+    ],
+    "logo": { # Meta data of an image asset. # Required. The logo image used by this ad.
+      "assetId": "A String", # Required. The unique ID of the asset.
+      "fileSize": "A String", # Output only. File size of the image asset in bytes.
+      "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+        "heightPixels": 42, # The height in pixels.
+        "widthPixels": 42, # The width in pixels.
+      },
+      "mimeType": "A String", # Output only. MIME type of the image asset.
+    },
+    "longHeadlines": [ # Required. The list of lone headlines shown on the ad.
+      "A String",
+    ],
+    "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes.
+    "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually.
+    "videos": [ # Required. The list of YouTube video assets used by this ad.
+      { # Details of a YouTube video.
+        "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+        "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+      },
+    ],
+  },
+  "displayName": "A String", # Required. The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes.
+  "displayVideoSourceAd": { # The ad sourced from a DV360 creative. # Output only. Details of an ad sourced from a Display & Video 360 creative.
+    "creativeId": "A String", # The ID of the source creative.
+  },
+  "entityStatus": "A String", # Required. The entity status of the ad.
+  "inStreamAd": { # Details for an in-stream ad. # Output only. Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives.
+    "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
+      "actionButtonLabel": "A String", # The text on the call-to-action button.
+      "actionHeadline": "A String", # The headline of the call-to-action banner.
+      "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+      "displayUrl": "A String", # The webpage address that appears with the ad.
+      "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+      "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+      "video": { # Details of a YouTube video. # The YouTube video of the ad.
+        "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+        "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+      },
+    },
+    "customParameters": { # The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+  },
+  "mastheadAd": { # Details for a Masthead Ad. # Output only. Details of an [ad served on the YouTube Home feed](//support.google.com/google-ads/answer/9709826).
+    "autoplayVideoDuration": "A String", # The duration of time the video will autoplay.
+    "autoplayVideoStartMillisecond": "A String", # The amount of time in milliseconds after which the video will start to play.
+    "callToActionButtonLabel": "A String", # The text on the call-to-action button.
+    "callToActionFinalUrl": "A String", # The destination URL for the call-to-action button.
+    "callToActionTrackingUrl": "A String", # The tracking URL for the call-to-action button.
+    "companionYoutubeVideos": [ # The videos that appear next to the Masthead Ad on desktop. Can be no more than two.
+      { # Details of a YouTube video.
+        "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+        "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+      },
+    ],
+    "description": "A String", # The description of the ad.
+    "headline": "A String", # The headline of the ad.
+    "showChannelArt": True or False, # Whether to show a background or banner that appears at the top of a YouTube page.
+    "video": { # Details of a YouTube video. # The YouTube video used by the ad.
+      "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+      "unavailableReason": "A String", # The reason why the video data is not available.
+      "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+    },
+    "videoAspectRatio": "A String", # The aspect ratio of the autoplaying YouTube video on the Masthead.
+  },
+  "name": "A String", # Output only. The resource name of the ad.
+  "nonSkippableAd": { # Details for a non-skippable ad. # Output only. Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives.
+    "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
+      "actionButtonLabel": "A String", # The text on the call-to-action button.
+      "actionHeadline": "A String", # The headline of the call-to-action banner.
+      "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+      "displayUrl": "A String", # The webpage address that appears with the ad.
+      "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+      "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+      "video": { # Details of a YouTube video. # The YouTube video of the ad.
+        "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+        "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+      },
+    },
+    "customParameters": { # The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+  },
+  "videoDiscoverAd": { # Details for a video discovery ad. # Output only. Details of an [ad promoting a video](//support.google.com/displayvideo/answer/6274216) that shows in places of discovery.
+    "description1": "A String", # First text line for the ad.
+    "description2": "A String", # Second text line for the ad.
+    "headline": "A String", # The headline of ad.
+    "thumbnail": "A String", # Thumbnail image used in the ad.
+    "video": { # Details of a YouTube video. # The YouTube video the ad promotes.
+      "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+      "unavailableReason": "A String", # The reason why the video data is not available.
+      "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+    },
+  },
+  "videoPerformanceAd": { # Details for a video performance ad. # Output only. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product.
+    "actionButtonLabels": [ # The list of text assets shown on the call-to-action button.
+      "A String",
+    ],
+    "companionBanners": [ # The list of companion banners used by this ad.
+      { # Meta data of an image asset.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+    ],
+    "customParameters": { # The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+    "descriptions": [ # The list of descriptions shown on the call-to-action banner.
+      "A String",
+    ],
+    "displayUrlBreadcrumb1": "A String", # The first piece after the domain in the display URL.
+    "displayUrlBreadcrumb2": "A String", # The second piece after the domain in the display URL.
+    "domain": "A String", # The domain of the display URL.
+    "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+    "headlines": [ # The list of headlines shown on the call-to-action banner.
+      "A String",
+    ],
+    "longHeadlines": [ # The list of lone headlines shown on the call-to-action banner.
+      "A String",
+    ],
+    "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+    "videos": [ # The list of YouTube video assets used by this ad.
+      { # Details of a YouTube video.
+        "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+        "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+      },
+    ],
+  },
+}
+
+  updateMask: string, Required. The mask to control which fields to update.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single ad associated with an ad group.
+  "adGroupAdId": "A String", # Output only. The unique ID of the ad. Assigned by the system.
+  "adGroupId": "A String", # Required. The unique ID of the ad group that the ad belongs to.
+  "adPolicy": { # A single ad policy associated with an ad group ad. # Output only. The policy approval status of the ad.
+    "adPolicyApprovalStatus": "A String", # The policy approval status of an ad, indicating the approval decision.
+    "adPolicyReviewStatus": "A String", # The policy review status of an ad, indicating where in the review process the ad is currently.
+    "adPolicyTopicEntry": [ # The entries for each policy topic identified as relating to the ad. Each entry includes the topic, restriction level, and guidance on how to fix policy issues.
+      { # An entry describing how an ad has been identified as relating to an ad policy.
+        "appealInfo": { # Information on how to appeal a policy decision. # Information on how to appeal the policy decision.
+          "appealFormLink": "A String", # Only available when appeal_type is `APPEAL_FORM`.
+          "appealType": "A String", # Whether the decision can be appealed through a self-service appeal or an appeal form.
+        },
+        "helpCenterLink": "A String", # Ad policy help center link for the policy topic.
+        "policyDecisionType": "A String", # The source of the policy decision.
+        "policyEnforcementMeans": "A String", # The policy enforcement means used in the policy review.
+        "policyLabel": "A String", # Localized label text for policy. Examples include "Trademarks in text", "Contains Alcohol", etc.
+        "policyTopic": "A String", # The policy topic. Examples include "TRADEMARKS", "ALCOHOL", etc.
+        "policyTopicConstraints": [ # The serving constraints relevant to the policy decision.
+          { # Details on ad serving constraints.
+            "certificateDomainMismatchCountryList": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where the resource's domain is not covered by the certificates associated with it.
+              "countries": [ # Countries where the ad cannot serve.
+                { # Represents a country restriction.
+                  "countryCriterionId": "A String", # The country criterion id.
+                  "countryLabel": "A String", # Localized name for the country. May be empty.
+                },
+              ],
+            },
+            "certificateMissingCountryList": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where a certificate is required for serving.
+              "countries": [ # Countries where the ad cannot serve.
+                { # Represents a country restriction.
+                  "countryCriterionId": "A String", # The country criterion id.
+                  "countryLabel": "A String", # Localized name for the country. May be empty.
+                },
+              ],
+            },
+            "countryConstraint": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where the ad cannot serve.
+              "countries": [ # Countries where the ad cannot serve.
+                { # Represents a country restriction.
+                  "countryCriterionId": "A String", # The country criterion id.
+                  "countryLabel": "A String", # Localized name for the country. May be empty.
+                },
+              ],
+            },
+            "globalCertificateDomainMismatch": { # Certificate is required to serve in any country and the existing certificate does not cover the ad's domain. # Certificate is required to serve in any country and the existing certificate does not cover the ad's domain.
+            },
+            "globalCertificateMissing": { # Certificate is required to serve in any country. # Certificate is required to serve in any country.
+            },
+            "requestCertificateFormLink": "A String", # Link to the form to request a certificate for the constraint.
+            "resellerConstraint": { # Policy topic was constrained due to disapproval of the website for reseller purposes. # Reseller constraint.
+            },
+          },
+        ],
+        "policyTopicDescription": "A String", # A short summary description of the policy topic.
+        "policyTopicEvidences": [ # The evidence used in the policy decision.
+          { # Evidence information used in the policy decision.
+            "counterfeit": { # Details on the counterfeit enforcement that caused a policy violation. # Counterfeit enforcement that caused a policy violation.
+              "owners": [ # The content or product owners that made a complaint.
+                "A String",
+              ],
+            },
+            "destinationMismatch": { # Details on a mismatch between destination URL types. # A mismatch between the ad destination URLs.
+              "uriTypes": [ # The set of URLs that do not match. The list can include single or multiple uri types. Example 1: [`DISPLAY_URL`, `FINAL_URL`] means ad display URL does not match with the ad final URL. Example 2: [`FINAL_URL`] means ad final URL did not match the crawled url, which is also considered as destination mismatch.
+                "A String",
+              ],
+            },
+            "destinationNotWorking": { # Details for on HTTP or DNS errors related to the ad destination. # Information on HTTP or DNS errors related to the ad destination.
+              "device": "A String", # The device where visiting the URL resulted in the error.
+              "dnsErrorType": "A String", # The type of DNS error.
+              "expandedUri": "A String", # The full URL that didn't work.
+              "httpErrorCode": "A String", # The HTTP error code.
+              "lastCheckedTime": "A String", # The last time the error was seen when navigating to URL.
+            },
+            "destinationTextList": { # A list of destination text that violated the policy. # The text in the destination of the ad that is causing a policy violation.
+              "destinationTexts": [ # Destination text that caused the policy finding.
+                "A String",
+              ],
+            },
+            "httpCode": 42, # HTTP code returned when the final URL was crawled.
+            "languageCode": "A String", # The language the ad was detected to be written in. This field uses IETF language tags, such as "en-US".
+            "legalRemoval": { # Legal related regulation enforcement, either from DMCA or local legal regulation. # Legal related regulation enforcement that caused a policy violation.
+              "complaintType": "A String", # The type of complaint causing the legal removal.
+              "countryRestrictions": [ # The countries restricted due to the legal removal.
+                { # Represents a country restriction.
+                  "countryCriterionId": "A String", # The country criterion id.
+                  "countryLabel": "A String", # Localized name for the country. May be empty.
+                },
+              ],
+              "dmca": { # DMCA complaint details. # Details on the DMCA regulation legal removal.
+                "complainant": "A String", # The entity who made the legal complaint.
+              },
+              "localLegal": { # Local legal regulation details. # Details on the local legal regulation legal removal.
+                "lawType": "A String", # Type of law for the legal notice.
+              },
+              "restrictedUris": [ # The urls restricted due to the legal removal.
+                "A String",
+              ],
+            },
+            "regionalRequirements": { # Trust & Safety (T&S) proactive enforcement for policies meant to address regional requirements. This is considered a Google-owned investigation instead of a regulation notice since it's proactive T&S enforcement. # T&S proactive enforcement that caused a policy violation.
+              "regionalRequirementsEntries": [ # List of regional requirements.
+                { # Policy level regional legal violation details.
+                  "countryRestrictions": [ # The countries restricted due to the legal policy.
+                    { # Represents a country restriction.
+                      "countryCriterionId": "A String", # The country criterion id.
+                      "countryLabel": "A String", # Localized name for the country. May be empty.
+                    },
+                  ],
+                  "legalPolicy": "A String", # The legal policy that is being violated.
+                },
+              ],
+            },
+            "textList": { # A list of fragments of text that violated the policy. # List of evidence found in the text of the ad.
+              "texts": [ # The fragments of text from the resource that caused the policy finding.
+                "A String",
+              ],
+            },
+            "trademark": { # Trademark terms that caused a policy violation. # Trademark terms that caused a policy violation.
+              "countryRestrictions": [ # Countries where the policy violation is relevant.
+                { # Represents a country restriction.
+                  "countryCriterionId": "A String", # The country criterion id.
+                  "countryLabel": "A String", # Localized name for the country. May be empty.
+                },
+              ],
+              "owner": "A String", # The trademark content owner.
+              "term": "A String", # The trademark term.
+            },
+            "websiteList": { # A list of websites that violated the policy. # List of websites linked with the ad.
+              "websites": [ # Websites that caused the policy finding.
+                "A String",
+              ],
+            },
+          },
+        ],
+        "policyTopicType": "A String", # How ad serving will be affected due to the relation to the ad policy topic.
+      },
+    ],
+  },
+  "adUrls": [ # Output only. List of URLs used by the ad.
+    { # Additional URLs related to the ad, including beacons.
+      "type": "A String", # The type of the Ad URL.
+      "url": "A String", # The URL string value.
+    },
+  ],
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad belongs to.
+  "audioAd": { # Details for an audio ad. # Output only. Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives.
+    "displayUrl": "A String", # The webpage address that appears with the ad.
+    "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+    "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+    "video": { # Details of a YouTube video. # The YouTube video of the ad.
+      "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+      "unavailableReason": "A String", # The reason why the video data is not available.
+      "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+    },
+  },
+  "bumperAd": { # Details for a bumper ad. # Output only. Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach.
+    "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
+      "actionButtonLabel": "A String", # The text on the call-to-action button.
+      "actionHeadline": "A String", # The headline of the call-to-action banner.
+      "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+      "displayUrl": "A String", # The webpage address that appears with the ad.
+      "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+      "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+      "video": { # Details of a YouTube video. # The YouTube video of the ad.
+        "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+        "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+      },
+    },
+  },
+  "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd).
+    "businessName": "A String", # Required. The business name shown on the ad.
+    "cards": [ # Required. The list of cards shown on the ad.
+      { # Details for a Demand Gen carousel card.
+        "callToAction": "A String", # Required. The call-to-action button shown on the card. Must use 10 characters or less.
+        "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the card on a mobile device.
+        "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the card.
+        "headline": "A String", # Required. The headline of the card.
+        "marketingImage": { # Meta data of an image asset. # Optional. The marketing image shown on the card.
+          "assetId": "A String", # Required. The unique ID of the asset.
+          "fileSize": "A String", # Output only. File size of the image asset in bytes.
+          "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+            "heightPixels": 42, # The height in pixels.
+            "widthPixels": 42, # The width in pixels.
+          },
+          "mimeType": "A String", # Output only. MIME type of the image asset.
+        },
+        "portraitMarketingImage": { # Meta data of an image asset. # Optional. The portrait marketing image shown on the card.
+          "assetId": "A String", # Required. The unique ID of the asset.
+          "fileSize": "A String", # Output only. File size of the image asset in bytes.
+          "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+            "heightPixels": 42, # The height in pixels.
+            "widthPixels": 42, # The width in pixels.
+          },
+          "mimeType": "A String", # Output only. MIME type of the image asset.
+        },
+        "squareMarketingImage": { # Meta data of an image asset. # Optional. The square marketing image shown on the card.
+          "assetId": "A String", # Required. The unique ID of the asset.
+          "fileSize": "A String", # Output only. File size of the image asset in bytes.
+          "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+            "heightPixels": 42, # The height in pixels.
+            "widthPixels": 42, # The width in pixels.
+          },
+          "mimeType": "A String", # Output only. MIME type of the image asset.
+        },
+      },
+    ],
+    "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+    "description": "A String", # Required. The description of the ad.
+    "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad.
+    "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs.
+    "headline": "A String", # Required. The headline of the ad.
+    "logo": { # Meta data of an image asset. # Required. The logo image used by this ad.
+      "assetId": "A String", # Required. The unique ID of the asset.
+      "fileSize": "A String", # Output only. File size of the image asset in bytes.
+      "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+        "heightPixels": 42, # The height in pixels.
+        "widthPixels": 42, # The width in pixels.
+      },
+      "mimeType": "A String", # Output only. MIME type of the image asset.
+    },
+    "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes.
+    "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually.
+  },
+  "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd).
+    "businessName": "A String", # Required. The business name shown on the ad.
+    "callToAction": "A String", # Required. The call-to-action button shown on the ad.
+    "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+    "descriptions": [ # Required. The list of descriptions shown on the ad.
+      "A String",
+    ],
+    "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the ad on a mobile device.
+    "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad.
+    "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs.
+    "headlines": [ # Required. The list of headlines shown on the ad.
+      "A String",
+    ],
+    "logoImages": [ # The list of logo images shown on the ad.
+      { # Meta data of an image asset.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+    ],
+    "marketingImages": [ # The list of marketing images shown on the ad.
+      { # Meta data of an image asset.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+    ],
+    "portraitMarketingImages": [ # The list of portrait marketing images shown on the ad.
+      { # Meta data of an image asset.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+    ],
+    "squareMarketingImages": [ # The list of square marketing images shown on the ad.
+      { # Meta data of an image asset.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+    ],
+    "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes.
+    "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually.
+  },
+  "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd).
+    "businessName": "A String", # Required. The business name shown on the ad.
+    "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE`
+    "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+    "description": "A String", # Required. The description of the ad.
+    "displayUrlBreadcrumb1": "A String", # Optional. The first piece after the domain in the display URL.
+    "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL.
+    "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad.
+    "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs.
+    "headline": "A String", # Required. The headline of the ad.
+    "logo": { # Meta data of an image asset. # Required. The logo image used by this ad.
+      "assetId": "A String", # Required. The unique ID of the asset.
+      "fileSize": "A String", # Output only. File size of the image asset in bytes.
+      "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+        "heightPixels": 42, # The height in pixels.
+        "widthPixels": 42, # The width in pixels.
+      },
+      "mimeType": "A String", # Output only. MIME type of the image asset.
+    },
+    "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes.
+    "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually.
+  },
+  "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd).
+    "businessName": "A String", # Required. The business name shown on the ad.
+    "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW`
+    "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad.
+      "assetId": "A String", # Required. The unique ID of the asset.
+      "fileSize": "A String", # Output only. File size of the image asset in bytes.
+      "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+        "heightPixels": 42, # The height in pixels.
+        "widthPixels": 42, # The width in pixels.
+      },
+      "mimeType": "A String", # Output only. MIME type of the image asset.
+    },
+    "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+    "descriptions": [ # Required. The list of descriptions shown on the ad.
+      "A String",
+    ],
+    "displayUrlBreadcrumb1": "A String", # Optional. The first piece after the domain in the display URL.
+    "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL.
+    "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the ad on a mobile device.
+    "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad.
+    "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs.
+    "headlines": [ # Required. The list of headlines shown on the ad.
+      "A String",
+    ],
+    "logo": { # Meta data of an image asset. # Required. The logo image used by this ad.
+      "assetId": "A String", # Required. The unique ID of the asset.
+      "fileSize": "A String", # Output only. File size of the image asset in bytes.
+      "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+        "heightPixels": 42, # The height in pixels.
+        "widthPixels": 42, # The width in pixels.
+      },
+      "mimeType": "A String", # Output only. MIME type of the image asset.
+    },
+    "longHeadlines": [ # Required. The list of lone headlines shown on the ad.
+      "A String",
+    ],
+    "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes.
+    "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually.
+    "videos": [ # Required. The list of YouTube video assets used by this ad.
+      { # Details of a YouTube video.
+        "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+        "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+      },
+    ],
+  },
+  "displayName": "A String", # Required. The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes.
+  "displayVideoSourceAd": { # The ad sourced from a DV360 creative. # Output only. Details of an ad sourced from a Display & Video 360 creative.
+    "creativeId": "A String", # The ID of the source creative.
+  },
+  "entityStatus": "A String", # Required. The entity status of the ad.
+  "inStreamAd": { # Details for an in-stream ad. # Output only. Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives.
+    "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
+      "actionButtonLabel": "A String", # The text on the call-to-action button.
+      "actionHeadline": "A String", # The headline of the call-to-action banner.
+      "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+      "displayUrl": "A String", # The webpage address that appears with the ad.
+      "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+      "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+      "video": { # Details of a YouTube video. # The YouTube video of the ad.
+        "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+        "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+      },
+    },
+    "customParameters": { # The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+  },
+  "mastheadAd": { # Details for a Masthead Ad. # Output only. Details of an [ad served on the YouTube Home feed](//support.google.com/google-ads/answer/9709826).
+    "autoplayVideoDuration": "A String", # The duration of time the video will autoplay.
+    "autoplayVideoStartMillisecond": "A String", # The amount of time in milliseconds after which the video will start to play.
+    "callToActionButtonLabel": "A String", # The text on the call-to-action button.
+    "callToActionFinalUrl": "A String", # The destination URL for the call-to-action button.
+    "callToActionTrackingUrl": "A String", # The tracking URL for the call-to-action button.
+    "companionYoutubeVideos": [ # The videos that appear next to the Masthead Ad on desktop. Can be no more than two.
+      { # Details of a YouTube video.
+        "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+        "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+      },
+    ],
+    "description": "A String", # The description of the ad.
+    "headline": "A String", # The headline of the ad.
+    "showChannelArt": True or False, # Whether to show a background or banner that appears at the top of a YouTube page.
+    "video": { # Details of a YouTube video. # The YouTube video used by the ad.
+      "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+      "unavailableReason": "A String", # The reason why the video data is not available.
+      "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+    },
+    "videoAspectRatio": "A String", # The aspect ratio of the autoplaying YouTube video on the Masthead.
+  },
+  "name": "A String", # Output only. The resource name of the ad.
+  "nonSkippableAd": { # Details for a non-skippable ad. # Output only. Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives.
+    "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
+      "actionButtonLabel": "A String", # The text on the call-to-action button.
+      "actionHeadline": "A String", # The headline of the call-to-action banner.
+      "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+      "displayUrl": "A String", # The webpage address that appears with the ad.
+      "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+      "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+      "video": { # Details of a YouTube video. # The YouTube video of the ad.
+        "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+        "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+      },
+    },
+    "customParameters": { # The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+  },
+  "videoDiscoverAd": { # Details for a video discovery ad. # Output only. Details of an [ad promoting a video](//support.google.com/displayvideo/answer/6274216) that shows in places of discovery.
+    "description1": "A String", # First text line for the ad.
+    "description2": "A String", # Second text line for the ad.
+    "headline": "A String", # The headline of ad.
+    "thumbnail": "A String", # Thumbnail image used in the ad.
+    "video": { # Details of a YouTube video. # The YouTube video the ad promotes.
+      "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+      "unavailableReason": "A String", # The reason why the video data is not available.
+      "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+    },
+  },
+  "videoPerformanceAd": { # Details for a video performance ad. # Output only. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product.
+    "actionButtonLabels": [ # The list of text assets shown on the call-to-action button.
+      "A String",
+    ],
+    "companionBanners": [ # The list of companion banners used by this ad.
+      { # Meta data of an image asset.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+    ],
+    "customParameters": { # The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+    "descriptions": [ # The list of descriptions shown on the call-to-action banner.
+      "A String",
+    ],
+    "displayUrlBreadcrumb1": "A String", # The first piece after the domain in the display URL.
+    "displayUrlBreadcrumb2": "A String", # The second piece after the domain in the display URL.
+    "domain": "A String", # The domain of the display URL.
+    "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+    "headlines": [ # The list of headlines shown on the call-to-action banner.
+      "A String",
+    ],
+    "longHeadlines": [ # The list of lone headlines shown on the call-to-action banner.
+      "A String",
+    ],
+    "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+    "videos": [ # The list of YouTube video assets used by this ad.
+      { # Details of a YouTube video.
+        "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+        "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+      },
+    ],
+  },
+}
\ No newline at end of file diff --git a/docs/dyn/displayvideo_v3.advertisers.adGroups.html b/docs/dyn/displayvideo_v3.advertisers.adGroups.html index c51de5c5aa..c2664f2cea 100644 --- a/docs/dyn/displayvideo_v3.advertisers.adGroups.html +++ b/docs/dyn/displayvideo_v3.advertisers.adGroups.html @@ -79,6 +79,9 @@

Instance Methods

Returns the targetingTypes Resource.

+

+ bulkEditAssignedTargetingOptions(advertiserId, body=None, x__xgafv=None)

+

Bulk edits targeting options for multiple ad groups. The same set of delete and create requests will be applied to all specified ad groups. Specifically, the operation will delete the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.delete_requests from each ad group, and then create the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.create_requests. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.

bulkListAdGroupAssignedTargetingOptions(advertiserId, adGroupIds=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists assigned targeting options for multiple ad groups across targeting types. Inherited assigned targeting options are not included.

@@ -88,6 +91,12 @@

Instance Methods

close()

Close httplib2 connections.

+

+ create(advertiserId, body=None, x__xgafv=None)

+

Creates a new ad group. Returns the newly created ad group if successful.

+

+ delete(advertiserId, adGroupId, x__xgafv=None)

+

Deletes a AdGroup. Returns error code `NOT_FOUND` if the ad group does not exist.

get(advertiserId, adGroupId, x__xgafv=None)

Gets an ad group.

@@ -97,7 +106,397 @@

Instance Methods

list_next()

Retrieves the next page of results.

+

+ patch(advertiserId, adGroupId, body=None, updateMask=None, x__xgafv=None)

+

Updates an existing ad group. Returns the updated ad group if successful.

Method Details

+
+ bulkEditAssignedTargetingOptions(advertiserId, body=None, x__xgafv=None) +
Bulk edits targeting options for multiple ad groups. The same set of delete and create requests will be applied to all specified ad groups. Specifically, the operation will delete the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.delete_requests from each ad group, and then create the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.create_requests. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser the ad groups belong to. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for BulkEditAdGroupAssignedTargetingOptions.
+  "adGroupIds": [ # Required. The IDs of the ad groups the assigned targeting options will belong to. A maximum of 25 ad group IDs can be specified.
+    "A String",
+  ],
+  "createRequests": [ # Optional. The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionRequest`. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`
+    { # A request listing which assigned targeting options of a given targeting type should be created and added.
+      "assignedTargetingOptions": [ # Required. The assigned targeting options to create and add.
+        { # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.
+          "ageRangeDetails": { # Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`.
+            "ageRange": "A String", # Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
+          },
+          "appCategoryDetails": { # Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+            "displayName": "A String", # Output only. The display name of the app category.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+          },
+          "appDetails": { # Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. # App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`.
+            "appId": "A String", # Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.
+            "appPlatform": "A String", # Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID.
+            "displayName": "A String", # Output only. The display name of the app.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+          },
+          "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.
+          "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`
+          "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource.
+            "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # Optional. The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other.
+              "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed.
+                { # Details of first and third party audience targeting setting.
+                  "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id.
+                  "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+                },
+              ],
+            },
+            "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other.
+              "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+                { # Details of Google audience targeting setting.
+                  "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+                },
+              ],
+            },
+            "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only.
+              "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.
+                { # Details of combined audience targeting setting.
+                  "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.
+                },
+              ],
+            },
+            "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only.
+              "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored.
+                { # Details of custom list targeting setting.
+                  "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id.
+                },
+              ],
+            },
+            "includedFirstAndThirdPartyAudienceGroups": [ # Optional. The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored.
+              { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other.
+                "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed.
+                  { # Details of first and third party audience targeting setting.
+                    "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id.
+                    "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+                  },
+                ],
+              },
+            ],
+            "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only.
+              "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+                { # Details of Google audience targeting setting.
+                  "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+                },
+              ],
+            },
+          },
+          "audioContentTypeDetails": { # Details for audio content type assigned targeting option. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect. # Audio content type details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`.
+            "audioContentType": "A String", # Required. The audio content type.
+          },
+          "authorizedSellerStatusDetails": { # Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the "Authorized Direct Sellers and Resellers" option. # Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.
+            "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target.
+            "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
+          },
+          "browserDetails": { # Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`.
+            "displayName": "A String", # Output only. The display name of the browser.
+            "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field.
+            "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.
+          },
+          "businessChainDetails": { # Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain details. This field will be populated when the targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.
+            "displayName": "A String", # Output only. The display name of a business chain, e.g. "KFC", "Chase Bank".
+            "proximityRadiusAmount": 3.14, # Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6.
+            "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+            "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions.
+          },
+          "carrierAndIspDetails": { # Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.
+            "displayName": "A String", # Output only. The display name of the carrier or ISP.
+            "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field.
+            "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
+          },
+          "categoryDetails": { # Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence.
+            "displayName": "A String", # Output only. The display name of the category.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.
+          },
+          "channelDetails": { # Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. # Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`.
+            "channelId": "A String", # Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
+            "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.
+          },
+          "contentDurationDetails": { # Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect. # Content duration details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+            "contentDuration": "A String", # Output only. The content duration.
+            "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+          },
+          "contentGenreDetails": { # Details for content genre assigned targeting option. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. Explicitly targeting all options is not supported. Remove all content genre targeting options to achieve this effect. # Content genre details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+            "displayName": "A String", # Output only. The display name of the content genre.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+          },
+          "contentInstreamPositionDetails": { # Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
+            "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.
+            "contentInstreamPosition": "A String", # Required. The content instream position for video or audio ads.
+          },
+          "contentOutstreamPositionDetails": { # Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
+            "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+            "contentOutstreamPosition": "A String", # Required. The content outstream position.
+          },
+          "contentStreamTypeDetails": { # Details for content stream type assigned targeting option. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect. # Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+            "contentStreamType": "A String", # Output only. The content stream type.
+            "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+          },
+          "contentThemeExclusionDetails": { # Targeting details for content theme. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`. # Content theme details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`. Content theme are targeting exclusions. Advertiser level content theme exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content theme in addition to advertiser exclusions.
+            "contentTheme": "A String", # Output only. An enum for the DV360 content theme classifier.
+            "excludedContentTheme": "A String", # Required. An enum for the DV360 content theme classified to be EXCLUDED.
+            "excludedTargetingOptionId": "A String", # Required. ID of the content theme to be EXCLUDED.
+          },
+          "dayAndTimeDetails": { # Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. # Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`.
+            "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting.
+            "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).
+            "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).
+            "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER.
+          },
+          "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+            "displayName": "A String", # Output only. The display name of the device make and model.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+          },
+          "deviceTypeDetails": { # Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.
+            "deviceType": "A String", # Required. The display name of the device type.
+            "youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items.
+          },
+          "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded.
+            "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED.
+          },
+          "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`.
+            "environment": "A String", # Required. The serving environment.
+          },
+          "exchangeDetails": { # Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`.
+            "exchange": "A String", # Required. The enum value for the exchange.
+          },
+          "genderDetails": { # Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`.
+            "gender": "A String", # Required. The gender of the audience.
+          },
+          "geoRegionDetails": { # Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`.
+            "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
+            "geoRegionType": "A String", # Output only. The type of geographic region targeting.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
+          },
+          "householdIncomeDetails": { # Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
+            "householdIncome": "A String", # Required. The household income of the audience.
+          },
+          "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option.
+          "inventorySourceDetails": { # Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. # Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.
+            "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
+          },
+          "inventorySourceGroupDetails": { # Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
+            "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
+          },
+          "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned.
+            "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted.
+              "A String",
+            ],
+            "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+          },
+          "languageDetails": { # Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`.
+            "displayName": "A String", # Output only. The display name of the language (e.g., "French").
+            "negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field.
+            "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
+          },
+          "name": "A String", # Output only. The resource name for this assigned targeting option.
+          "nativeContentPositionDetails": { # Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect. # Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`.
+            "contentPosition": "A String", # Required. The content position.
+          },
+          "negativeKeywordListDetails": { # Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource.
+            "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
+          },
+          "omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details. This field will be populated when the targeting_type is `TARGETING_TYPE_OMID`.
+            "omid": "A String", # Required. The type of Open Measurement enabled inventory.
+          },
+          "onScreenPositionDetails": { # On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+            "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+            "onScreenPosition": "A String", # Output only. The on screen position.
+            "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+          },
+          "operatingSystemDetails": { # Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+            "displayName": "A String", # Output only. The display name of the operating system.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+          },
+          "parentalStatusDetails": { # Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.
+            "parentalStatus": "A String", # Required. The parental status of the audience.
+          },
+          "poiDetails": { # Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_POI`. # POI details. This field will be populated when the targeting_type is `TARGETING_TYPE_POI`.
+            "displayName": "A String", # Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available.
+            "latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
+            "longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
+            "proximityRadiusAmount": 3.14, # Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`.
+            "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+            "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_POI`. Accepted POI targeting option IDs can be retrieved using `targetingTypes.targetingOptions.search`. If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID "40741469;-74003387". **Upon** **creation, this field value will be updated to append a semicolon and** **alphanumerical hash value if only latitude/longitude coordinates are** **provided.**
+          },
+          "proximityLocationListDetails": { # Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
+            "proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
+            "proximityRadius": 3.14, # Required. Radius expressed in the distance units set in proximity_radius_unit. This represents the size of the area around a chosen location that will be targeted. Radius should be between 1 and 500 miles or 800 kilometers.
+            "proximityRadiusUnit": "A String", # Required. Radius distance units.
+          },
+          "regionalLocationListDetails": { # Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
+          },
+          "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them.
+            "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
+          },
+          "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`.
+            "sessionPosition": "A String", # The position where the ad will show in a session.
+          },
+          "subExchangeDetails": { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.
+            "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
+          },
+          "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option.
+          "thirdPartyVerifierDetails": { # Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
+            "adloox": { # Details of Scope3 (previously known as Adloox) brand safety settings. # Third party brand verifier -- Scope3 (previously known as Adloox).
+              "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads.
+              "excludedAdlooxCategories": [ # Scope3 categories to exclude.
+                "A String",
+              ],
+              "excludedFraudIvtMfaCategories": [ # Optional. Scope3's fraud IVT MFA categories to exclude.
+                "A String",
+              ],
+              "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads.
+            },
+            "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
+              "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
+                "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings.
+                "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings.
+              },
+              "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating.
+                "A String",
+              ],
+              "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls.
+                "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable.
+                "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories.
+                  "A String",
+                ],
+                "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories.
+                  "A String",
+                ],
+              },
+              "customSegmentId": "A String", # The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic
+              "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
+                "iab": "A String", # Target web and app inventory to maximize IAB viewable rate.
+                "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration.
+              },
+              "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates.
+                "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats.
+                "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT.
+              },
+              "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
+                "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size.
+                "videoIab": "A String", # Target web inventory to maximize IAB viewable rate.
+                "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate.
+              },
+            },
+            "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
+              "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive.
+                "A String",
+              ],
+              "displayViewability": "A String", # Display Viewability section (applicable to display line items only).
+              "excludeUnrateable": True or False, # Brand Safety - **Unrateable**.
+              "excludedAdFraudRisk": "A String", # Ad Fraud settings.
+              "excludedAdultRisk": "A String", # Brand Safety - **Adult content**.
+              "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**.
+              "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**.
+              "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**.
+              "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**.
+              "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**.
+              "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**.
+              "excludedViolenceRisk": "A String", # Brand Safety - **Violence**.
+              "qualitySyncCustomSegmentId": [ # Optional. The quality sync custom segment ID provided by Integral Ad Science. The ID must be between `3000000` and `4999999`, inclusive.
+                "A String",
+              ],
+              "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only).
+              "videoViewability": "A String", # Video Viewability Section (applicable to video line items only).
+            },
+          },
+          "urlDetails": { # Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. # URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "url": "A String", # Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`.
+          },
+          "userRewardedContentDetails": { # User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+            "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+            "userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
+          },
+          "videoPlayerSizeDetails": { # Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. # Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
+            "videoPlayerSize": "A String", # Required. The video player size.
+          },
+          "viewabilityDetails": { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource.
+            "viewability": "A String", # Required. The predicted viewability percentage.
+          },
+          "youtubeChannelDetails": { # Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. # YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.
+            "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+          },
+          "youtubeVideoDetails": { # Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. # YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
+          },
+        },
+      ],
+      "targetingType": "A String", # Required. Identifies the type of this assigned targeting option.
+    },
+  ],
+  "deleteRequests": [ # Optional. The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`
+    { # A request listing which assigned targeting options of a given targeting type should be deleted.
+      "assignedTargetingOptionIds": [ # Required. The assigned targeting option IDs to delete.
+        "A String",
+      ],
+      "targetingType": "A String", # Required. Identifies the type of this assigned targeting option.
+    },
+  ],
+}
+
+  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 BulkEditAssignedTargetingOptions.
+  "errors": [ # Output only. The error information for each ad group that failed to update.
+    { # 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).
+      "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.
+    },
+  ],
+  "failedAdGroupIds": [ # Output only. The IDs of the ad groups which failed to update.
+    "A String",
+  ],
+  "updatedAdGroupIds": [ # Output only. The IDs of the ad groups which were successfully updated.
+    "A String",
+  ],
+}
+
+
bulkListAdGroupAssignedTargetingOptions(advertiserId, adGroupIds=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists assigned targeting options for multiple ad groups across targeting types. Inherited assigned targeting options are not included.
@@ -248,7 +647,7 @@ 

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -288,6 +687,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -471,6 +873,179 @@

Method Details

Close httplib2 connections.
+
+ create(advertiserId, body=None, x__xgafv=None) +
Creates a new ad group. Returns the newly created ad group if successful.
+
+Args:
+  advertiserId: string, Output only. The unique ID of the advertiser the ad group belongs to. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single ad group associated with a line item.
+  "adGroupFormat": "A String", # Required. The format of the ads in the ad group.
+  "adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system.
+  "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Specifies the inventory control of the ad group. This field is required for Demand Gen ad groups.
+    "adGroupInventoryStrategy": "A String", # The inventory strategy.
+    "selectedInventories": { # The inventory control of the ad group. # The selected inventories.
+      "allowDiscover": True or False, # Whether the ad group is opted-in to Discover inventory.
+      "allowGmail": True or False, # Whether the ad group is opted-in to Gmail inventory.
+      "allowGoogleDisplayNetwork": True or False, # Whether the ad group is opted-in to Google Display Network inventory.
+      "allowYoutubeFeed": True or False, # Whether the ad group is opted-in to YouTube in-feed inventory.
+      "allowYoutubeShorts": True or False, # Whether the ad group is opted-in to YouTube shorts inventory.
+      "allowYoutubeStream": True or False, # Whether the ad group is opted-in to YouTube in-stream.
+    },
+  },
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad group belongs to.
+  "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy used by the ad group. Only the youtubeAndPartnersBid and demandGenBid field can be used in the bidding strategy.
+    "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity.
+      "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field.
+      "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value.
+      "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level.
+      "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0.
+    },
+    "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
+      "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
+    },
+    "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
+      "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
+      "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
+      "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account.
+    },
+    "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity.
+      "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
+      "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value.
+      "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.
+    },
+    "youtubeAndPartnersBid": { # Settings that control the bid strategy for YouTube and Partners resources. # A bid strategy used by YouTube and Partners resources. It can only be used for a YouTube and Partners line item or ad group entity.
+      "adGroupEffectiveTargetCpaSource": "A String", # Output only. Source of the effective target CPA value for ad group.
+      "adGroupEffectiveTargetCpaValue": "A String", # Output only. The effective target CPA for ad group, in micros of advertiser's currency.
+      "type": "A String", # The type of the bidding strategy.
+      "value": "A String", # The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_SHARE_OF_VOICE` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0.
+    },
+  },
+  "displayName": "A String", # Required. The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.
+  "entityStatus": "A String", # Required. Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group's parent line item is not active, the ad group can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
+  "lineItemId": "A String", # Required. The unique ID of the line item that the ad group belongs to.
+  "name": "A String", # Output only. Identifier. The resource name of the ad group.
+  "productFeedData": { # The details of product feed. # Optional. The settings of the product feed in this ad group.
+    "isFeedDisabled": True or False, # Whether the product feed has opted-out of showing products.
+    "productMatchDimensions": [ # A list of dimensions used to match products.
+      { # A dimension used to match products.
+        "customLabel": { # The key and value of a custom label. # The custom label to match all the products with the label.
+          "key": "A String", # The key of the label.
+          "value": "A String", # The value of the label.
+        },
+        "productOfferId": "A String", # The ID of the product offer to match with a product with the same offer ID.
+      },
+    ],
+    "productMatchType": "A String", # How products are selected by the product feed.
+  },
+  "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # Optional. The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group.
+    "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.
+    "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.
+    "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single ad group associated with a line item.
+  "adGroupFormat": "A String", # Required. The format of the ads in the ad group.
+  "adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system.
+  "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Specifies the inventory control of the ad group. This field is required for Demand Gen ad groups.
+    "adGroupInventoryStrategy": "A String", # The inventory strategy.
+    "selectedInventories": { # The inventory control of the ad group. # The selected inventories.
+      "allowDiscover": True or False, # Whether the ad group is opted-in to Discover inventory.
+      "allowGmail": True or False, # Whether the ad group is opted-in to Gmail inventory.
+      "allowGoogleDisplayNetwork": True or False, # Whether the ad group is opted-in to Google Display Network inventory.
+      "allowYoutubeFeed": True or False, # Whether the ad group is opted-in to YouTube in-feed inventory.
+      "allowYoutubeShorts": True or False, # Whether the ad group is opted-in to YouTube shorts inventory.
+      "allowYoutubeStream": True or False, # Whether the ad group is opted-in to YouTube in-stream.
+    },
+  },
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad group belongs to.
+  "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy used by the ad group. Only the youtubeAndPartnersBid and demandGenBid field can be used in the bidding strategy.
+    "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity.
+      "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field.
+      "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value.
+      "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level.
+      "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0.
+    },
+    "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
+      "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
+    },
+    "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
+      "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
+      "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
+      "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account.
+    },
+    "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity.
+      "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
+      "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value.
+      "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.
+    },
+    "youtubeAndPartnersBid": { # Settings that control the bid strategy for YouTube and Partners resources. # A bid strategy used by YouTube and Partners resources. It can only be used for a YouTube and Partners line item or ad group entity.
+      "adGroupEffectiveTargetCpaSource": "A String", # Output only. Source of the effective target CPA value for ad group.
+      "adGroupEffectiveTargetCpaValue": "A String", # Output only. The effective target CPA for ad group, in micros of advertiser's currency.
+      "type": "A String", # The type of the bidding strategy.
+      "value": "A String", # The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_SHARE_OF_VOICE` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0.
+    },
+  },
+  "displayName": "A String", # Required. The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.
+  "entityStatus": "A String", # Required. Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group's parent line item is not active, the ad group can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
+  "lineItemId": "A String", # Required. The unique ID of the line item that the ad group belongs to.
+  "name": "A String", # Output only. Identifier. The resource name of the ad group.
+  "productFeedData": { # The details of product feed. # Optional. The settings of the product feed in this ad group.
+    "isFeedDisabled": True or False, # Whether the product feed has opted-out of showing products.
+    "productMatchDimensions": [ # A list of dimensions used to match products.
+      { # A dimension used to match products.
+        "customLabel": { # The key and value of a custom label. # The custom label to match all the products with the label.
+          "key": "A String", # The key of the label.
+          "value": "A String", # The value of the label.
+        },
+        "productOfferId": "A String", # The ID of the product offer to match with a product with the same offer ID.
+      },
+    ],
+    "productMatchType": "A String", # How products are selected by the product feed.
+  },
+  "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # Optional. The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group.
+    "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.
+    "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.
+    "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`.
+  },
+}
+
+ +
+ delete(advertiserId, adGroupId, x__xgafv=None) +
Deletes a AdGroup. Returns error code `NOT_FOUND` if the ad group does not exist.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser this ad group belongs to. (required)
+  adGroupId: string, Required. The ID of the ad group to delete. (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(advertiserId, adGroupId, x__xgafv=None)
Gets an ad group.
@@ -489,8 +1064,25 @@ 

Method Details

{ # A single ad group associated with a line item. "adGroupFormat": "A String", # Required. The format of the ads in the ad group. "adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system. + "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Specifies the inventory control of the ad group. This field is required for Demand Gen ad groups. + "adGroupInventoryStrategy": "A String", # The inventory strategy. + "selectedInventories": { # The inventory control of the ad group. # The selected inventories. + "allowDiscover": True or False, # Whether the ad group is opted-in to Discover inventory. + "allowGmail": True or False, # Whether the ad group is opted-in to Gmail inventory. + "allowGoogleDisplayNetwork": True or False, # Whether the ad group is opted-in to Google Display Network inventory. + "allowYoutubeFeed": True or False, # Whether the ad group is opted-in to YouTube in-feed inventory. + "allowYoutubeShorts": True or False, # Whether the ad group is opted-in to YouTube shorts inventory. + "allowYoutubeStream": True or False, # Whether the ad group is opted-in to YouTube in-stream. + }, + }, "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad group belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy used by the ad group. Only the youtubeAndPartnersBid and demandGenBid field can be used in the bidding strategy. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, @@ -561,8 +1153,25 @@

Method Details

{ # A single ad group associated with a line item. "adGroupFormat": "A String", # Required. The format of the ads in the ad group. "adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system. + "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Specifies the inventory control of the ad group. This field is required for Demand Gen ad groups. + "adGroupInventoryStrategy": "A String", # The inventory strategy. + "selectedInventories": { # The inventory control of the ad group. # The selected inventories. + "allowDiscover": True or False, # Whether the ad group is opted-in to Discover inventory. + "allowGmail": True or False, # Whether the ad group is opted-in to Gmail inventory. + "allowGoogleDisplayNetwork": True or False, # Whether the ad group is opted-in to Google Display Network inventory. + "allowYoutubeFeed": True or False, # Whether the ad group is opted-in to YouTube in-feed inventory. + "allowYoutubeShorts": True or False, # Whether the ad group is opted-in to YouTube shorts inventory. + "allowYoutubeStream": True or False, # Whether the ad group is opted-in to YouTube in-stream. + }, + }, "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad group belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy used by the ad group. Only the youtubeAndPartnersBid and demandGenBid field can be used in the bidding strategy. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, @@ -627,4 +1236,160 @@

Method Details

+
+ patch(advertiserId, adGroupId, body=None, updateMask=None, x__xgafv=None) +
Updates an existing ad group. Returns the updated ad group if successful.
+
+Args:
+  advertiserId: string, Output only. The unique ID of the advertiser the ad group belongs to. (required)
+  adGroupId: string, Output only. The unique ID of the ad group. Assigned by the system. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single ad group associated with a line item.
+  "adGroupFormat": "A String", # Required. The format of the ads in the ad group.
+  "adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system.
+  "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Specifies the inventory control of the ad group. This field is required for Demand Gen ad groups.
+    "adGroupInventoryStrategy": "A String", # The inventory strategy.
+    "selectedInventories": { # The inventory control of the ad group. # The selected inventories.
+      "allowDiscover": True or False, # Whether the ad group is opted-in to Discover inventory.
+      "allowGmail": True or False, # Whether the ad group is opted-in to Gmail inventory.
+      "allowGoogleDisplayNetwork": True or False, # Whether the ad group is opted-in to Google Display Network inventory.
+      "allowYoutubeFeed": True or False, # Whether the ad group is opted-in to YouTube in-feed inventory.
+      "allowYoutubeShorts": True or False, # Whether the ad group is opted-in to YouTube shorts inventory.
+      "allowYoutubeStream": True or False, # Whether the ad group is opted-in to YouTube in-stream.
+    },
+  },
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad group belongs to.
+  "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy used by the ad group. Only the youtubeAndPartnersBid and demandGenBid field can be used in the bidding strategy.
+    "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity.
+      "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field.
+      "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value.
+      "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level.
+      "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0.
+    },
+    "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
+      "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
+    },
+    "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
+      "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
+      "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
+      "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account.
+    },
+    "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity.
+      "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
+      "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value.
+      "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.
+    },
+    "youtubeAndPartnersBid": { # Settings that control the bid strategy for YouTube and Partners resources. # A bid strategy used by YouTube and Partners resources. It can only be used for a YouTube and Partners line item or ad group entity.
+      "adGroupEffectiveTargetCpaSource": "A String", # Output only. Source of the effective target CPA value for ad group.
+      "adGroupEffectiveTargetCpaValue": "A String", # Output only. The effective target CPA for ad group, in micros of advertiser's currency.
+      "type": "A String", # The type of the bidding strategy.
+      "value": "A String", # The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_SHARE_OF_VOICE` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0.
+    },
+  },
+  "displayName": "A String", # Required. The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.
+  "entityStatus": "A String", # Required. Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group's parent line item is not active, the ad group can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
+  "lineItemId": "A String", # Required. The unique ID of the line item that the ad group belongs to.
+  "name": "A String", # Output only. Identifier. The resource name of the ad group.
+  "productFeedData": { # The details of product feed. # Optional. The settings of the product feed in this ad group.
+    "isFeedDisabled": True or False, # Whether the product feed has opted-out of showing products.
+    "productMatchDimensions": [ # A list of dimensions used to match products.
+      { # A dimension used to match products.
+        "customLabel": { # The key and value of a custom label. # The custom label to match all the products with the label.
+          "key": "A String", # The key of the label.
+          "value": "A String", # The value of the label.
+        },
+        "productOfferId": "A String", # The ID of the product offer to match with a product with the same offer ID.
+      },
+    ],
+    "productMatchType": "A String", # How products are selected by the product feed.
+  },
+  "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # Optional. The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group.
+    "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.
+    "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.
+    "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`.
+  },
+}
+
+  updateMask: string, Required. The mask to control which fields to update.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single ad group associated with a line item.
+  "adGroupFormat": "A String", # Required. The format of the ads in the ad group.
+  "adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system.
+  "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Specifies the inventory control of the ad group. This field is required for Demand Gen ad groups.
+    "adGroupInventoryStrategy": "A String", # The inventory strategy.
+    "selectedInventories": { # The inventory control of the ad group. # The selected inventories.
+      "allowDiscover": True or False, # Whether the ad group is opted-in to Discover inventory.
+      "allowGmail": True or False, # Whether the ad group is opted-in to Gmail inventory.
+      "allowGoogleDisplayNetwork": True or False, # Whether the ad group is opted-in to Google Display Network inventory.
+      "allowYoutubeFeed": True or False, # Whether the ad group is opted-in to YouTube in-feed inventory.
+      "allowYoutubeShorts": True or False, # Whether the ad group is opted-in to YouTube shorts inventory.
+      "allowYoutubeStream": True or False, # Whether the ad group is opted-in to YouTube in-stream.
+    },
+  },
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad group belongs to.
+  "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy used by the ad group. Only the youtubeAndPartnersBid and demandGenBid field can be used in the bidding strategy.
+    "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity.
+      "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field.
+      "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value.
+      "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level.
+      "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0.
+    },
+    "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
+      "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
+    },
+    "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
+      "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
+      "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
+      "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account.
+    },
+    "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity.
+      "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
+      "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value.
+      "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.
+    },
+    "youtubeAndPartnersBid": { # Settings that control the bid strategy for YouTube and Partners resources. # A bid strategy used by YouTube and Partners resources. It can only be used for a YouTube and Partners line item or ad group entity.
+      "adGroupEffectiveTargetCpaSource": "A String", # Output only. Source of the effective target CPA value for ad group.
+      "adGroupEffectiveTargetCpaValue": "A String", # Output only. The effective target CPA for ad group, in micros of advertiser's currency.
+      "type": "A String", # The type of the bidding strategy.
+      "value": "A String", # The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_SHARE_OF_VOICE` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0.
+    },
+  },
+  "displayName": "A String", # Required. The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.
+  "entityStatus": "A String", # Required. Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group's parent line item is not active, the ad group can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
+  "lineItemId": "A String", # Required. The unique ID of the line item that the ad group belongs to.
+  "name": "A String", # Output only. Identifier. The resource name of the ad group.
+  "productFeedData": { # The details of product feed. # Optional. The settings of the product feed in this ad group.
+    "isFeedDisabled": True or False, # Whether the product feed has opted-out of showing products.
+    "productMatchDimensions": [ # A list of dimensions used to match products.
+      { # A dimension used to match products.
+        "customLabel": { # The key and value of a custom label. # The custom label to match all the products with the label.
+          "key": "A String", # The key of the label.
+          "value": "A String", # The value of the label.
+        },
+        "productOfferId": "A String", # The ID of the product offer to match with a product with the same offer ID.
+      },
+    ],
+    "productMatchType": "A String", # How products are selected by the product feed.
+  },
+  "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # Optional. The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group.
+    "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.
+    "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.
+    "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/displayvideo_v3.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v3.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html index ad23a61808..10b694f49c 100644 --- a/docs/dyn/displayvideo_v3.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v3.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html @@ -77,6 +77,12 @@

Instance Methods

close()

Close httplib2 connections.

+

+ create(advertiserId, adGroupId, targetingType, body=None, x__xgafv=None)

+

Assigns a targeting option to an ad group. Returns the assigned targeting option if successful. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.

+

+ delete(advertiserId, adGroupId, targetingType, assignedTargetingOptionId, x__xgafv=None)

+

Deletes an assigned targeting option from an ad group. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.

get(advertiserId, adGroupId, targetingType, assignedTargetingOptionId, x__xgafv=None)

Gets a single targeting option assigned to an ad group. Inherited assigned targeting options are not included.

@@ -88,8 +94,809 @@

Instance Methods

Retrieves the next page of results.

Method Details

- close() -
Close httplib2 connections.
+ close() +
Close httplib2 connections.
+
+ +
+ create(advertiserId, adGroupId, targetingType, body=None, x__xgafv=None) +
Assigns a targeting option to an ad group. Returns the assigned targeting option if successful. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser the ad group belongs to. (required)
+  adGroupId: string, Required. The ID of the ad group the assigned targeting option will belong to. (required)
+  targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO` (required)
+    Allowed values
+      TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version.
+      TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps).
+      TARGETING_TYPE_APP_CATEGORY - Target an app category (for example, education or puzzle games).
+      TARGETING_TYPE_APP - Target a specific app (for example, Angry Birds).
+      TARGETING_TYPE_URL - Target a specific url (for example, quora.com).
+      TARGETING_TYPE_DAY_AND_TIME - Target ads during a chosen time period on a specific day.
+      TARGETING_TYPE_AGE_RANGE - Target ads to a specific age range (for example, 18-24).
+      TARGETING_TYPE_REGIONAL_LOCATION_LIST - Target ads to the specified regions on a regional location list.
+      TARGETING_TYPE_PROXIMITY_LOCATION_LIST - Target ads to the specified points of interest on a proximity location list.
+      TARGETING_TYPE_GENDER - Target ads to a specific gender (for example, female or male).
+      TARGETING_TYPE_VIDEO_PLAYER_SIZE - Target a specific video player size for video ads.
+      TARGETING_TYPE_USER_REWARDED_CONTENT - Target user rewarded content for video ads.
+      TARGETING_TYPE_PARENTAL_STATUS - Target ads to a specific parental status (for example, parent or not a parent).
+      TARGETING_TYPE_CONTENT_INSTREAM_POSITION - Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
+      TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION - Target ads in a specific content outstream position.
+      TARGETING_TYPE_DEVICE_TYPE - Target ads to a specific device type (for example, tablet or connected TV).
+      TARGETING_TYPE_AUDIENCE_GROUP - Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
+      TARGETING_TYPE_BROWSER - Target ads to specific web browsers (for example, Chrome).
+      TARGETING_TYPE_HOUSEHOLD_INCOME - Target ads to a specific household income range (for example, top 10%).
+      TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position.
+      TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify).
+      TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
+      TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult).
+      TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app).
+      TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
+      TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS).
+      TARGETING_TYPE_DEVICE_MAKE_MODEL - Target ads to a specific device make or model (for example, Roku or Samsung).
+      TARGETING_TYPE_KEYWORD - Target ads to a specific keyword (for example, dog or retriever).
+      TARGETING_TYPE_NEGATIVE_KEYWORD_LIST - Target ads to a specific negative keyword list.
+      TARGETING_TYPE_VIEWABILITY - Target ads to a specific viewability (for example, 80% viewable).
+      TARGETING_TYPE_CATEGORY - Target ads to a specific content category (for example, arts & entertainment).
+      TARGETING_TYPE_INVENTORY_SOURCE - Purchase impressions from specific deals and auction packages.
+      TARGETING_TYPE_LANGUAGE - Target ads to a specific language (for example, English or Japanese).
+      TARGETING_TYPE_AUTHORIZED_SELLER_STATUS - Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
+      TARGETING_TYPE_GEO_REGION - Target ads to a specific regional location (for example, a city or state).
+      TARGETING_TYPE_INVENTORY_SOURCE_GROUP - Purchase impressions from a group of deals and auction packages.
+      TARGETING_TYPE_EXCHANGE - Purchase impressions from specific exchanges.
+      TARGETING_TYPE_SUB_EXCHANGE - Purchase impressions from specific sub-exchanges.
+      TARGETING_TYPE_POI - Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
+      TARGETING_TYPE_BUSINESS_CHAIN - Target ads around locations of a business chain within a specific geo region.
+      TARGETING_TYPE_CONTENT_DURATION - Target ads to a specific video content duration.
+      TARGETING_TYPE_CONTENT_STREAM_TYPE - Target ads to a specific video content stream type.
+      TARGETING_TYPE_NATIVE_CONTENT_POSITION - Target ads to a specific native content position.
+      TARGETING_TYPE_OMID - Target ads in an Open Measurement enabled inventory.
+      TARGETING_TYPE_AUDIO_CONTENT_TYPE - Target ads to a specific audio content type.
+      TARGETING_TYPE_CONTENT_GENRE - Target ads to a specific content genre.
+      TARGETING_TYPE_YOUTUBE_VIDEO - Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_YOUTUBE_CHANNEL - Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_SESSION_POSITION - Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
+      TARGETING_TYPE_CONTENT_THEME_EXCLUSION - Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.
+  "ageRangeDetails": { # Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`.
+    "ageRange": "A String", # Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
+  },
+  "appCategoryDetails": { # Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+    "displayName": "A String", # Output only. The display name of the app category.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+  },
+  "appDetails": { # Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. # App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`.
+    "appId": "A String", # Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.
+    "appPlatform": "A String", # Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID.
+    "displayName": "A String", # Output only. The display name of the app.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.
+  "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`
+  "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource.
+    "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # Optional. The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other.
+      "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed.
+        { # Details of first and third party audience targeting setting.
+          "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id.
+          "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+        },
+      ],
+    },
+    "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other.
+      "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+        { # Details of Google audience targeting setting.
+          "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+        },
+      ],
+    },
+    "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only.
+      "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.
+        { # Details of combined audience targeting setting.
+          "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.
+        },
+      ],
+    },
+    "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only.
+      "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored.
+        { # Details of custom list targeting setting.
+          "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id.
+        },
+      ],
+    },
+    "includedFirstAndThirdPartyAudienceGroups": [ # Optional. The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored.
+      { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other.
+        "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed.
+          { # Details of first and third party audience targeting setting.
+            "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id.
+            "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+          },
+        ],
+      },
+    ],
+    "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only.
+      "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+        { # Details of Google audience targeting setting.
+          "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+        },
+      ],
+    },
+  },
+  "audioContentTypeDetails": { # Details for audio content type assigned targeting option. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect. # Audio content type details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`.
+    "audioContentType": "A String", # Required. The audio content type.
+  },
+  "authorizedSellerStatusDetails": { # Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the "Authorized Direct Sellers and Resellers" option. # Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.
+    "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
+  },
+  "browserDetails": { # Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`.
+    "displayName": "A String", # Output only. The display name of the browser.
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.
+  },
+  "businessChainDetails": { # Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain details. This field will be populated when the targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.
+    "displayName": "A String", # Output only. The display name of a business chain, e.g. "KFC", "Chase Bank".
+    "proximityRadiusAmount": 3.14, # Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6.
+    "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions.
+  },
+  "carrierAndIspDetails": { # Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.
+    "displayName": "A String", # Output only. The display name of the carrier or ISP.
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
+  },
+  "categoryDetails": { # Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence.
+    "displayName": "A String", # Output only. The display name of the category.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.
+  },
+  "channelDetails": { # Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. # Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`.
+    "channelId": "A String", # Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
+    "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.
+  },
+  "contentDurationDetails": { # Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect. # Content duration details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+    "contentDuration": "A String", # Output only. The content duration.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+  },
+  "contentGenreDetails": { # Details for content genre assigned targeting option. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. Explicitly targeting all options is not supported. Remove all content genre targeting options to achieve this effect. # Content genre details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+    "displayName": "A String", # Output only. The display name of the content genre.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+  },
+  "contentInstreamPositionDetails": { # Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.
+    "contentInstreamPosition": "A String", # Required. The content instream position for video or audio ads.
+  },
+  "contentOutstreamPositionDetails": { # Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+    "contentOutstreamPosition": "A String", # Required. The content outstream position.
+  },
+  "contentStreamTypeDetails": { # Details for content stream type assigned targeting option. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect. # Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+    "contentStreamType": "A String", # Output only. The content stream type.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+  },
+  "contentThemeExclusionDetails": { # Targeting details for content theme. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`. # Content theme details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`. Content theme are targeting exclusions. Advertiser level content theme exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content theme in addition to advertiser exclusions.
+    "contentTheme": "A String", # Output only. An enum for the DV360 content theme classifier.
+    "excludedContentTheme": "A String", # Required. An enum for the DV360 content theme classified to be EXCLUDED.
+    "excludedTargetingOptionId": "A String", # Required. ID of the content theme to be EXCLUDED.
+  },
+  "dayAndTimeDetails": { # Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. # Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`.
+    "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting.
+    "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).
+    "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).
+    "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER.
+  },
+  "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+    "displayName": "A String", # Output only. The display name of the device make and model.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+  },
+  "deviceTypeDetails": { # Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.
+    "deviceType": "A String", # Required. The display name of the device type.
+    "youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items.
+  },
+  "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded.
+    "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED.
+  },
+  "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`.
+    "environment": "A String", # Required. The serving environment.
+  },
+  "exchangeDetails": { # Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`.
+    "exchange": "A String", # Required. The enum value for the exchange.
+  },
+  "genderDetails": { # Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`.
+    "gender": "A String", # Required. The gender of the audience.
+  },
+  "geoRegionDetails": { # Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`.
+    "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
+    "geoRegionType": "A String", # Output only. The type of geographic region targeting.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
+  },
+  "householdIncomeDetails": { # Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
+    "householdIncome": "A String", # Required. The household income of the audience.
+  },
+  "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option.
+  "inventorySourceDetails": { # Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. # Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.
+    "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
+  },
+  "inventorySourceGroupDetails": { # Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
+    "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
+  },
+  "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned.
+    "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted.
+      "A String",
+    ],
+    "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "languageDetails": { # Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`.
+    "displayName": "A String", # Output only. The display name of the language (e.g., "French").
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
+  },
+  "name": "A String", # Output only. The resource name for this assigned targeting option.
+  "nativeContentPositionDetails": { # Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect. # Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`.
+    "contentPosition": "A String", # Required. The content position.
+  },
+  "negativeKeywordListDetails": { # Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource.
+    "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
+  },
+  "omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details. This field will be populated when the targeting_type is `TARGETING_TYPE_OMID`.
+    "omid": "A String", # Required. The type of Open Measurement enabled inventory.
+  },
+  "onScreenPositionDetails": { # On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+    "onScreenPosition": "A String", # Output only. The on screen position.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+  },
+  "operatingSystemDetails": { # Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+    "displayName": "A String", # Output only. The display name of the operating system.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+  },
+  "parentalStatusDetails": { # Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.
+    "parentalStatus": "A String", # Required. The parental status of the audience.
+  },
+  "poiDetails": { # Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_POI`. # POI details. This field will be populated when the targeting_type is `TARGETING_TYPE_POI`.
+    "displayName": "A String", # Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available.
+    "latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
+    "longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
+    "proximityRadiusAmount": 3.14, # Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`.
+    "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_POI`. Accepted POI targeting option IDs can be retrieved using `targetingTypes.targetingOptions.search`. If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID "40741469;-74003387". **Upon** **creation, this field value will be updated to append a semicolon and** **alphanumerical hash value if only latitude/longitude coordinates are** **provided.**
+  },
+  "proximityLocationListDetails": { # Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
+    "proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
+    "proximityRadius": 3.14, # Required. Radius expressed in the distance units set in proximity_radius_unit. This represents the size of the area around a chosen location that will be targeted. Radius should be between 1 and 500 miles or 800 kilometers.
+    "proximityRadiusUnit": "A String", # Required. Radius distance units.
+  },
+  "regionalLocationListDetails": { # Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
+  },
+  "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them.
+    "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
+  },
+  "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`.
+    "sessionPosition": "A String", # The position where the ad will show in a session.
+  },
+  "subExchangeDetails": { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
+  },
+  "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option.
+  "thirdPartyVerifierDetails": { # Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
+    "adloox": { # Details of Scope3 (previously known as Adloox) brand safety settings. # Third party brand verifier -- Scope3 (previously known as Adloox).
+      "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads.
+      "excludedAdlooxCategories": [ # Scope3 categories to exclude.
+        "A String",
+      ],
+      "excludedFraudIvtMfaCategories": [ # Optional. Scope3's fraud IVT MFA categories to exclude.
+        "A String",
+      ],
+      "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads.
+    },
+    "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
+      "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
+        "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings.
+        "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings.
+      },
+      "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating.
+        "A String",
+      ],
+      "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls.
+        "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable.
+        "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories.
+          "A String",
+        ],
+        "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories.
+          "A String",
+        ],
+      },
+      "customSegmentId": "A String", # The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic
+      "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
+        "iab": "A String", # Target web and app inventory to maximize IAB viewable rate.
+        "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration.
+      },
+      "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates.
+        "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats.
+        "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT.
+      },
+      "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
+        "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size.
+        "videoIab": "A String", # Target web inventory to maximize IAB viewable rate.
+        "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate.
+      },
+    },
+    "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
+      "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive.
+        "A String",
+      ],
+      "displayViewability": "A String", # Display Viewability section (applicable to display line items only).
+      "excludeUnrateable": True or False, # Brand Safety - **Unrateable**.
+      "excludedAdFraudRisk": "A String", # Ad Fraud settings.
+      "excludedAdultRisk": "A String", # Brand Safety - **Adult content**.
+      "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**.
+      "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**.
+      "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**.
+      "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**.
+      "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**.
+      "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**.
+      "excludedViolenceRisk": "A String", # Brand Safety - **Violence**.
+      "qualitySyncCustomSegmentId": [ # Optional. The quality sync custom segment ID provided by Integral Ad Science. The ID must be between `3000000` and `4999999`, inclusive.
+        "A String",
+      ],
+      "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only).
+      "videoViewability": "A String", # Video Viewability Section (applicable to video line items only).
+    },
+  },
+  "urlDetails": { # Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. # URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "url": "A String", # Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`.
+  },
+  "userRewardedContentDetails": { # User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+    "userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
+  },
+  "videoPlayerSizeDetails": { # Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. # Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
+    "videoPlayerSize": "A String", # Required. The video player size.
+  },
+  "viewabilityDetails": { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource.
+    "viewability": "A String", # Required. The predicted viewability percentage.
+  },
+  "youtubeChannelDetails": { # Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. # YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.
+    "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "youtubeVideoDetails": { # Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. # YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.
+  "ageRangeDetails": { # Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`.
+    "ageRange": "A String", # Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
+  },
+  "appCategoryDetails": { # Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+    "displayName": "A String", # Output only. The display name of the app category.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+  },
+  "appDetails": { # Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. # App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`.
+    "appId": "A String", # Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.
+    "appPlatform": "A String", # Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID.
+    "displayName": "A String", # Output only. The display name of the app.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.
+  "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`
+  "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource.
+    "excludedFirstAndThirdPartyAudienceGroup": { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. # Optional. The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other.
+      "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed.
+        { # Details of first and third party audience targeting setting.
+          "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id.
+          "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+        },
+      ],
+    },
+    "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other.
+      "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+        { # Details of Google audience targeting setting.
+          "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+        },
+      ],
+    },
+    "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only.
+      "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.
+        { # Details of combined audience targeting setting.
+          "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.
+        },
+      ],
+    },
+    "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only.
+      "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored.
+        { # Details of custom list targeting setting.
+          "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id.
+        },
+      ],
+    },
+    "includedFirstAndThirdPartyAudienceGroups": [ # Optional. The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored.
+      { # Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other.
+        "settings": [ # Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with the same id are not allowed.
+          { # Details of first and third party audience targeting setting.
+            "firstAndThirdPartyAudienceId": "A String", # Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id.
+            "recency": "A String", # Optional. The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+          },
+        ],
+      },
+    ],
+    "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only.
+      "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+        { # Details of Google audience targeting setting.
+          "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+        },
+      ],
+    },
+  },
+  "audioContentTypeDetails": { # Details for audio content type assigned targeting option. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect. # Audio content type details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`.
+    "audioContentType": "A String", # Required. The audio content type.
+  },
+  "authorizedSellerStatusDetails": { # Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the "Authorized Direct Sellers and Resellers" option. # Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.
+    "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
+  },
+  "browserDetails": { # Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`.
+    "displayName": "A String", # Output only. The display name of the browser.
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.
+  },
+  "businessChainDetails": { # Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain details. This field will be populated when the targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.
+    "displayName": "A String", # Output only. The display name of a business chain, e.g. "KFC", "Chase Bank".
+    "proximityRadiusAmount": 3.14, # Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6.
+    "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions.
+  },
+  "carrierAndIspDetails": { # Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.
+    "displayName": "A String", # Output only. The display name of the carrier or ISP.
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
+  },
+  "categoryDetails": { # Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence.
+    "displayName": "A String", # Output only. The display name of the category.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.
+  },
+  "channelDetails": { # Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. # Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`.
+    "channelId": "A String", # Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
+    "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.
+  },
+  "contentDurationDetails": { # Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect. # Content duration details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+    "contentDuration": "A String", # Output only. The content duration.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+  },
+  "contentGenreDetails": { # Details for content genre assigned targeting option. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. Explicitly targeting all options is not supported. Remove all content genre targeting options to achieve this effect. # Content genre details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+    "displayName": "A String", # Output only. The display name of the content genre.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+  },
+  "contentInstreamPositionDetails": { # Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.
+    "contentInstreamPosition": "A String", # Required. The content instream position for video or audio ads.
+  },
+  "contentOutstreamPositionDetails": { # Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+    "contentOutstreamPosition": "A String", # Required. The content outstream position.
+  },
+  "contentStreamTypeDetails": { # Details for content stream type assigned targeting option. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect. # Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+    "contentStreamType": "A String", # Output only. The content stream type.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+  },
+  "contentThemeExclusionDetails": { # Targeting details for content theme. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`. # Content theme details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`. Content theme are targeting exclusions. Advertiser level content theme exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content theme in addition to advertiser exclusions.
+    "contentTheme": "A String", # Output only. An enum for the DV360 content theme classifier.
+    "excludedContentTheme": "A String", # Required. An enum for the DV360 content theme classified to be EXCLUDED.
+    "excludedTargetingOptionId": "A String", # Required. ID of the content theme to be EXCLUDED.
+  },
+  "dayAndTimeDetails": { # Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. # Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`.
+    "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting.
+    "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).
+    "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).
+    "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER.
+  },
+  "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+    "displayName": "A String", # Output only. The display name of the device make and model.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+  },
+  "deviceTypeDetails": { # Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.
+    "deviceType": "A String", # Required. The display name of the device type.
+    "youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items.
+  },
+  "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded.
+    "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED.
+  },
+  "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`.
+    "environment": "A String", # Required. The serving environment.
+  },
+  "exchangeDetails": { # Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`.
+    "exchange": "A String", # Required. The enum value for the exchange.
+  },
+  "genderDetails": { # Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`.
+    "gender": "A String", # Required. The gender of the audience.
+  },
+  "geoRegionDetails": { # Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`.
+    "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
+    "geoRegionType": "A String", # Output only. The type of geographic region targeting.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
+  },
+  "householdIncomeDetails": { # Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
+    "householdIncome": "A String", # Required. The household income of the audience.
+  },
+  "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option.
+  "inventorySourceDetails": { # Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. # Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.
+    "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
+  },
+  "inventorySourceGroupDetails": { # Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
+    "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
+  },
+  "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned.
+    "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted.
+      "A String",
+    ],
+    "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "languageDetails": { # Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`.
+    "displayName": "A String", # Output only. The display name of the language (e.g., "French").
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
+  },
+  "name": "A String", # Output only. The resource name for this assigned targeting option.
+  "nativeContentPositionDetails": { # Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect. # Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`.
+    "contentPosition": "A String", # Required. The content position.
+  },
+  "negativeKeywordListDetails": { # Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource.
+    "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
+  },
+  "omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details. This field will be populated when the targeting_type is `TARGETING_TYPE_OMID`.
+    "omid": "A String", # Required. The type of Open Measurement enabled inventory.
+  },
+  "onScreenPositionDetails": { # On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+    "onScreenPosition": "A String", # Output only. The on screen position.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+  },
+  "operatingSystemDetails": { # Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+    "displayName": "A String", # Output only. The display name of the operating system.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+  },
+  "parentalStatusDetails": { # Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.
+    "parentalStatus": "A String", # Required. The parental status of the audience.
+  },
+  "poiDetails": { # Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_POI`. # POI details. This field will be populated when the targeting_type is `TARGETING_TYPE_POI`.
+    "displayName": "A String", # Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available.
+    "latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
+    "longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
+    "proximityRadiusAmount": 3.14, # Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`.
+    "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_POI`. Accepted POI targeting option IDs can be retrieved using `targetingTypes.targetingOptions.search`. If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID "40741469;-74003387". **Upon** **creation, this field value will be updated to append a semicolon and** **alphanumerical hash value if only latitude/longitude coordinates are** **provided.**
+  },
+  "proximityLocationListDetails": { # Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
+    "proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
+    "proximityRadius": 3.14, # Required. Radius expressed in the distance units set in proximity_radius_unit. This represents the size of the area around a chosen location that will be targeted. Radius should be between 1 and 500 miles or 800 kilometers.
+    "proximityRadiusUnit": "A String", # Required. Radius distance units.
+  },
+  "regionalLocationListDetails": { # Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
+  },
+  "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them.
+    "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
+  },
+  "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`.
+    "sessionPosition": "A String", # The position where the ad will show in a session.
+  },
+  "subExchangeDetails": { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
+  },
+  "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option.
+  "thirdPartyVerifierDetails": { # Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
+    "adloox": { # Details of Scope3 (previously known as Adloox) brand safety settings. # Third party brand verifier -- Scope3 (previously known as Adloox).
+      "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads.
+      "excludedAdlooxCategories": [ # Scope3 categories to exclude.
+        "A String",
+      ],
+      "excludedFraudIvtMfaCategories": [ # Optional. Scope3's fraud IVT MFA categories to exclude.
+        "A String",
+      ],
+      "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads.
+    },
+    "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
+      "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
+        "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings.
+        "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings.
+      },
+      "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating.
+        "A String",
+      ],
+      "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls.
+        "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable.
+        "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories.
+          "A String",
+        ],
+        "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories.
+          "A String",
+        ],
+      },
+      "customSegmentId": "A String", # The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic
+      "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
+        "iab": "A String", # Target web and app inventory to maximize IAB viewable rate.
+        "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration.
+      },
+      "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates.
+        "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats.
+        "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT.
+      },
+      "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
+        "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size.
+        "videoIab": "A String", # Target web inventory to maximize IAB viewable rate.
+        "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate.
+      },
+    },
+    "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
+      "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive.
+        "A String",
+      ],
+      "displayViewability": "A String", # Display Viewability section (applicable to display line items only).
+      "excludeUnrateable": True or False, # Brand Safety - **Unrateable**.
+      "excludedAdFraudRisk": "A String", # Ad Fraud settings.
+      "excludedAdultRisk": "A String", # Brand Safety - **Adult content**.
+      "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**.
+      "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**.
+      "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**.
+      "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**.
+      "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**.
+      "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**.
+      "excludedViolenceRisk": "A String", # Brand Safety - **Violence**.
+      "qualitySyncCustomSegmentId": [ # Optional. The quality sync custom segment ID provided by Integral Ad Science. The ID must be between `3000000` and `4999999`, inclusive.
+        "A String",
+      ],
+      "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only).
+      "videoViewability": "A String", # Video Viewability Section (applicable to video line items only).
+    },
+  },
+  "urlDetails": { # Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. # URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "url": "A String", # Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`.
+  },
+  "userRewardedContentDetails": { # User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+    "userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
+  },
+  "videoPlayerSizeDetails": { # Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. # Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
+    "videoPlayerSize": "A String", # Required. The video player size.
+  },
+  "viewabilityDetails": { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource.
+    "viewability": "A String", # Required. The predicted viewability percentage.
+  },
+  "youtubeChannelDetails": { # Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. # YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.
+    "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "youtubeVideoDetails": { # Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. # YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
+  },
+}
+
+ +
+ delete(advertiserId, adGroupId, targetingType, assignedTargetingOptionId, x__xgafv=None) +
Deletes an assigned targeting option from an ad group. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser the ad group belongs to. (required)
+  adGroupId: string, Required. The ID of the ad group the assigned targeting option belongs to. (required)
+  targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO` (required)
+    Allowed values
+      TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version.
+      TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps).
+      TARGETING_TYPE_APP_CATEGORY - Target an app category (for example, education or puzzle games).
+      TARGETING_TYPE_APP - Target a specific app (for example, Angry Birds).
+      TARGETING_TYPE_URL - Target a specific url (for example, quora.com).
+      TARGETING_TYPE_DAY_AND_TIME - Target ads during a chosen time period on a specific day.
+      TARGETING_TYPE_AGE_RANGE - Target ads to a specific age range (for example, 18-24).
+      TARGETING_TYPE_REGIONAL_LOCATION_LIST - Target ads to the specified regions on a regional location list.
+      TARGETING_TYPE_PROXIMITY_LOCATION_LIST - Target ads to the specified points of interest on a proximity location list.
+      TARGETING_TYPE_GENDER - Target ads to a specific gender (for example, female or male).
+      TARGETING_TYPE_VIDEO_PLAYER_SIZE - Target a specific video player size for video ads.
+      TARGETING_TYPE_USER_REWARDED_CONTENT - Target user rewarded content for video ads.
+      TARGETING_TYPE_PARENTAL_STATUS - Target ads to a specific parental status (for example, parent or not a parent).
+      TARGETING_TYPE_CONTENT_INSTREAM_POSITION - Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
+      TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION - Target ads in a specific content outstream position.
+      TARGETING_TYPE_DEVICE_TYPE - Target ads to a specific device type (for example, tablet or connected TV).
+      TARGETING_TYPE_AUDIENCE_GROUP - Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
+      TARGETING_TYPE_BROWSER - Target ads to specific web browsers (for example, Chrome).
+      TARGETING_TYPE_HOUSEHOLD_INCOME - Target ads to a specific household income range (for example, top 10%).
+      TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position.
+      TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify).
+      TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
+      TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult).
+      TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app).
+      TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
+      TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS).
+      TARGETING_TYPE_DEVICE_MAKE_MODEL - Target ads to a specific device make or model (for example, Roku or Samsung).
+      TARGETING_TYPE_KEYWORD - Target ads to a specific keyword (for example, dog or retriever).
+      TARGETING_TYPE_NEGATIVE_KEYWORD_LIST - Target ads to a specific negative keyword list.
+      TARGETING_TYPE_VIEWABILITY - Target ads to a specific viewability (for example, 80% viewable).
+      TARGETING_TYPE_CATEGORY - Target ads to a specific content category (for example, arts & entertainment).
+      TARGETING_TYPE_INVENTORY_SOURCE - Purchase impressions from specific deals and auction packages.
+      TARGETING_TYPE_LANGUAGE - Target ads to a specific language (for example, English or Japanese).
+      TARGETING_TYPE_AUTHORIZED_SELLER_STATUS - Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
+      TARGETING_TYPE_GEO_REGION - Target ads to a specific regional location (for example, a city or state).
+      TARGETING_TYPE_INVENTORY_SOURCE_GROUP - Purchase impressions from a group of deals and auction packages.
+      TARGETING_TYPE_EXCHANGE - Purchase impressions from specific exchanges.
+      TARGETING_TYPE_SUB_EXCHANGE - Purchase impressions from specific sub-exchanges.
+      TARGETING_TYPE_POI - Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
+      TARGETING_TYPE_BUSINESS_CHAIN - Target ads around locations of a business chain within a specific geo region.
+      TARGETING_TYPE_CONTENT_DURATION - Target ads to a specific video content duration.
+      TARGETING_TYPE_CONTENT_STREAM_TYPE - Target ads to a specific video content stream type.
+      TARGETING_TYPE_NATIVE_CONTENT_POSITION - Target ads to a specific native content position.
+      TARGETING_TYPE_OMID - Target ads in an Open Measurement enabled inventory.
+      TARGETING_TYPE_AUDIO_CONTENT_TYPE - Target ads to a specific audio content type.
+      TARGETING_TYPE_CONTENT_GENRE - Target ads to a specific content genre.
+      TARGETING_TYPE_YOUTUBE_VIDEO - Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_YOUTUBE_CHANNEL - Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_SESSION_POSITION - Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
+      TARGETING_TYPE_CONTENT_THEME_EXCLUSION - Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.
+  assignedTargetingOptionId: string, Required. The ID of the assigned targeting option to delete. (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); }
+}
@@ -287,7 +1094,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -327,6 +1134,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -687,7 +1497,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -727,6 +1537,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, diff --git a/docs/dyn/displayvideo_v3.advertisers.html b/docs/dyn/displayvideo_v3.advertisers.html index 88acdfc713..bf5521d888 100644 --- a/docs/dyn/displayvideo_v3.advertisers.html +++ b/docs/dyn/displayvideo_v3.advertisers.html @@ -493,7 +493,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -533,6 +533,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -842,7 +845,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -882,6 +885,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -1348,7 +1354,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1388,6 +1394,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, diff --git a/docs/dyn/displayvideo_v3.advertisers.insertionOrders.html b/docs/dyn/displayvideo_v3.advertisers.insertionOrders.html index a389f66861..17a9c320a2 100644 --- a/docs/dyn/displayvideo_v3.advertisers.insertionOrders.html +++ b/docs/dyn/displayvideo_v3.advertisers.insertionOrders.html @@ -113,6 +113,12 @@

Method Details

{ # A single insertion order. "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, @@ -213,6 +219,12 @@

Method Details

{ # A single insertion order. "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, @@ -340,6 +352,12 @@

Method Details

{ # A single insertion order. "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, @@ -453,6 +471,12 @@

Method Details

{ # A single insertion order. "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, @@ -573,6 +597,12 @@

Method Details

{ # A single insertion order. "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, @@ -674,6 +704,12 @@

Method Details

{ # A single insertion order. "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, diff --git a/docs/dyn/displayvideo_v3.advertisers.lineItems.html b/docs/dyn/displayvideo_v3.advertisers.lineItems.html index fb7c2eb6dd..23fb202b42 100644 --- a/docs/dyn/displayvideo_v3.advertisers.lineItems.html +++ b/docs/dyn/displayvideo_v3.advertisers.lineItems.html @@ -256,7 +256,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -296,6 +296,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -649,7 +652,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -689,6 +692,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -884,6 +890,12 @@

Method Details

"targetLineItem": { # A single line item. # Required. A line item object containing the fields to be updated and the new values to assign to all line items specified in line_item_ids." "advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, @@ -907,7 +919,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -922,10 +934,41 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` * `THIRD_PARTY_VENDOR_GEMIUS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + }, + }, "displayName": "A String", # Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`. "excludeNewExchanges": True or False, # Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default. @@ -944,7 +987,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -982,7 +1025,7 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. + "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. @@ -1013,25 +1056,25 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_KANTAR_MILLWARD_BROWN` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_KANTAR_MILLWARD_BROWN` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` + "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` * `THIRD_PARTY_VENDOR_GEMIUS` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` + "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1115,6 +1158,12 @@

Method Details

{ # A single line item. "advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, @@ -1138,7 +1187,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -1153,10 +1202,41 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` * `THIRD_PARTY_VENDOR_GEMIUS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + }, + }, "displayName": "A String", # Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`. "excludeNewExchanges": True or False, # Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default. @@ -1175,7 +1255,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -1213,7 +1293,7 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. + "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. @@ -1244,25 +1324,25 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_KANTAR_MILLWARD_BROWN` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_KANTAR_MILLWARD_BROWN` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` + "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` * `THIRD_PARTY_VENDOR_GEMIUS` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` + "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1306,6 +1386,12 @@

Method Details

{ # A single line item. "advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, @@ -1329,7 +1415,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -1344,10 +1430,41 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` * `THIRD_PARTY_VENDOR_GEMIUS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + }, + }, "displayName": "A String", # Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`. "excludeNewExchanges": True or False, # Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default. @@ -1366,7 +1483,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -1404,7 +1521,7 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. + "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. @@ -1435,25 +1552,25 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_KANTAR_MILLWARD_BROWN` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_KANTAR_MILLWARD_BROWN` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` + "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` * `THIRD_PARTY_VENDOR_GEMIUS` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` + "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1552,6 +1669,12 @@

Method Details

{ # A single line item. "advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, @@ -1575,7 +1698,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -1590,10 +1713,41 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` * `THIRD_PARTY_VENDOR_GEMIUS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + }, + }, "displayName": "A String", # Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`. "excludeNewExchanges": True or False, # Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default. @@ -1612,7 +1766,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -1650,7 +1804,7 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. + "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. @@ -1681,25 +1835,25 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_KANTAR_MILLWARD_BROWN` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_KANTAR_MILLWARD_BROWN` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` + "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` * `THIRD_PARTY_VENDOR_GEMIUS` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` + "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1756,6 +1910,12 @@

Method Details

{ # A single line item. "advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, @@ -1779,7 +1939,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -1794,10 +1954,41 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` * `THIRD_PARTY_VENDOR_GEMIUS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + }, + }, "displayName": "A String", # Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`. "excludeNewExchanges": True or False, # Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default. @@ -1816,7 +2007,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -1854,7 +2045,7 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. + "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. @@ -1885,25 +2076,25 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_KANTAR_MILLWARD_BROWN` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_KANTAR_MILLWARD_BROWN` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` + "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` * `THIRD_PARTY_VENDOR_GEMIUS` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` + "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1967,6 +2158,12 @@

Method Details

{ # A single line item. "advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, @@ -1990,7 +2187,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -2005,10 +2202,41 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` * `THIRD_PARTY_VENDOR_GEMIUS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + }, + }, "displayName": "A String", # Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`. "excludeNewExchanges": True or False, # Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default. @@ -2027,7 +2255,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -2065,7 +2293,7 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. + "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. @@ -2096,25 +2324,25 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_KANTAR_MILLWARD_BROWN` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_KANTAR_MILLWARD_BROWN` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` + "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` * `THIRD_PARTY_VENDOR_GEMIUS` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` + "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -2159,6 +2387,12 @@

Method Details

{ # A single line item. "advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, @@ -2182,7 +2416,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -2197,10 +2431,41 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` * `THIRD_PARTY_VENDOR_GEMIUS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + }, + }, "displayName": "A String", # Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`. "excludeNewExchanges": True or False, # Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default. @@ -2219,7 +2484,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -2257,7 +2522,7 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. + "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. @@ -2288,25 +2553,25 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_KANTAR_MILLWARD_BROWN` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_KANTAR_MILLWARD_BROWN` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` + "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` * `THIRD_PARTY_VENDOR_GEMIUS` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` + "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. diff --git a/docs/dyn/displayvideo_v3.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v3.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html index 1f7db791c1..8ad52cd941 100644 --- a/docs/dyn/displayvideo_v3.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v3.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html @@ -287,7 +287,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -327,6 +327,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -621,7 +624,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -661,6 +664,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -1088,7 +1094,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1128,6 +1134,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -1488,7 +1497,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1528,6 +1537,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, diff --git a/docs/dyn/displayvideo_v3.advertisers.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v3.advertisers.targetingTypes.assignedTargetingOptions.html index 58324feb66..01f4608762 100644 --- a/docs/dyn/displayvideo_v3.advertisers.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v3.advertisers.targetingTypes.assignedTargetingOptions.html @@ -286,7 +286,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -326,6 +326,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -620,7 +623,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -660,6 +663,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -1085,7 +1091,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1125,6 +1131,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -1484,7 +1493,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1524,6 +1533,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, diff --git a/docs/dyn/displayvideo_v3.partners.html b/docs/dyn/displayvideo_v3.partners.html index 97077ed5ed..a0c6f16d22 100644 --- a/docs/dyn/displayvideo_v3.partners.html +++ b/docs/dyn/displayvideo_v3.partners.html @@ -245,7 +245,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -285,6 +285,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -594,7 +597,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -634,6 +637,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, diff --git a/docs/dyn/displayvideo_v3.partners.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v3.partners.targetingTypes.assignedTargetingOptions.html index fba0032ea0..0275e81212 100644 --- a/docs/dyn/displayvideo_v3.partners.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v3.partners.targetingTypes.assignedTargetingOptions.html @@ -286,7 +286,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -326,6 +326,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -620,7 +623,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -660,6 +663,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -1085,7 +1091,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1125,6 +1131,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -1484,7 +1493,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1524,6 +1533,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, diff --git a/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html b/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html index 06193e4083..221739a601 100644 --- a/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html +++ b/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html @@ -77,6 +77,12 @@

Instance Methods

close()

Close httplib2 connections.

+

+ create(advertiserId, body=None, x__xgafv=None)

+

Creates an ad group ad.

+

+ delete(advertiserId, adGroupAdId, x__xgafv=None)

+

Deletes an ad group ad.

get(advertiserId, adGroupAdId, x__xgafv=None)

Gets an ad group ad.

@@ -86,6 +92,9 @@

Instance Methods

list_next()

Retrieves the next page of results.

+

+ patch(advertiserId, adGroupAdId, body=None, updateMask=None, x__xgafv=None)

+

Updates an ad group ad.

Method Details

close() @@ -93,21 +102,15 @@

Method Details

- get(advertiserId, adGroupAdId, x__xgafv=None) -
Gets an ad group ad.
+    create(advertiserId, body=None, x__xgafv=None)
+  
Creates an ad group ad.
 
 Args:
-  advertiserId: string, Required. The ID of the advertiser this ad group ad belongs to. (required)
-  adGroupAdId: string, Required. The ID of the ad to fetch. (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
+  advertiserId: string, Output only. The unique ID of the advertiser the ad belongs to. (required)
+  body: object, The request body.
+    The object takes the form of:
 
-    { # A single ad associated with an ad group.
+{ # A single ad associated with an ad group.
   "adGroupAdId": "A String", # Output only. The unique ID of the ad. Assigned by the system.
   "adGroupId": "A String", # Required. The unique ID of the ad group that the ad belongs to.
   "adPolicy": { # A single ad policy associated with an ad group ad. # Output only. The policy approval status of the ad.
@@ -265,6 +268,7 @@ 

Method Details

"actionButtonLabel": "A String", # The text on the call-to-action button. "actionHeadline": "A String", # The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad. + "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. "heightPixels": 42, # The height in pixels. @@ -282,6 +286,196 @@

Method Details

}, }, }, + "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). + "businessName": "A String", # Required. The business name shown on the ad. + "cards": [ # Required. The list of cards shown on the ad. + { # Details for a Demand Gen carousel card. + "callToAction": "A String", # Required. The call-to-action button shown on the card. Must use 10 characters or less. + "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the card on a mobile device. + "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the card. + "headline": "A String", # Required. The headline of the card. + "marketingImage": { # Meta data of an image asset. # Optional. The marketing image shown on the card. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. + }, + "mimeType": "A String", # Output only. MIME type of the image asset. + }, + "portraitMarketingImage": { # Meta data of an image asset. # Optional. The portrait marketing image shown on the card. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. + }, + "mimeType": "A String", # Output only. MIME type of the image asset. + }, + "squareMarketingImage": { # Meta data of an image asset. # Optional. The square marketing image shown on the card. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. + }, + "mimeType": "A String", # Output only. MIME type of the image asset. + }, + }, + ], + "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "a_key": "A String", + }, + "description": "A String", # Required. The description of the ad. + "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. + "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. + "headline": "A String", # Required. The headline of the ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. + }, + "mimeType": "A String", # Output only. MIME type of the image asset. + }, + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. + }, + "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). + "businessName": "A String", # Required. The business name shown on the ad. + "callToAction": "A String", # Required. The call-to-action button shown on the ad. + "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "a_key": "A String", + }, + "descriptions": [ # Required. The list of descriptions shown on the ad. + "A String", + ], + "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the ad on a mobile device. + "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. + "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. + "headlines": [ # Required. The list of headlines shown on the ad. + "A String", + ], + "logoImages": [ # The list of logo images shown on the ad. + { # Meta data of an image asset. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. + }, + "mimeType": "A String", # Output only. MIME type of the image asset. + }, + ], + "marketingImages": [ # The list of marketing images shown on the ad. + { # Meta data of an image asset. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. + }, + "mimeType": "A String", # Output only. MIME type of the image asset. + }, + ], + "portraitMarketingImages": [ # The list of portrait marketing images shown on the ad. + { # Meta data of an image asset. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. + }, + "mimeType": "A String", # Output only. MIME type of the image asset. + }, + ], + "squareMarketingImages": [ # The list of square marketing images shown on the ad. + { # Meta data of an image asset. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. + }, + "mimeType": "A String", # Output only. MIME type of the image asset. + }, + ], + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. + }, + "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). + "businessName": "A String", # Required. The business name shown on the ad. + "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` + "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "a_key": "A String", + }, + "description": "A String", # Required. The description of the ad. + "displayUrlBreadcrumb1": "A String", # Optional. The first piece after the domain in the display URL. + "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL. + "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. + "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. + "headline": "A String", # Required. The headline of the ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. + }, + "mimeType": "A String", # Output only. MIME type of the image asset. + }, + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. + }, + "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). + "businessName": "A String", # Required. The business name shown on the ad. + "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` + "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. + }, + "mimeType": "A String", # Output only. MIME type of the image asset. + }, + "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "a_key": "A String", + }, + "descriptions": [ # Required. The list of descriptions shown on the ad. + "A String", + ], + "displayUrlBreadcrumb1": "A String", # Optional. The first piece after the domain in the display URL. + "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL. + "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the ad on a mobile device. + "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. + "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. + "headlines": [ # Required. The list of headlines shown on the ad. + "A String", + ], + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. + }, + "mimeType": "A String", # Output only. MIME type of the image asset. + }, + "longHeadlines": [ # Required. The list of lone headlines shown on the ad. + "A String", + ], + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. + "videos": [ # Required. The list of YouTube video assets used by this ad. + { # Details of a YouTube video. + "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. + "unavailableReason": "A String", # The reason why the video data is not available. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + }, + ], + }, "displayName": "A String", # Required. The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes. "displayVideoSourceAd": { # The ad sourced from a DV360 creative. # Output only. Details of an ad sourced from a Display & Video 360 creative. "creativeId": "A String", # The ID of the source creative. @@ -292,6 +486,7 @@

Method Details

"actionButtonLabel": "A String", # The text on the call-to-action button. "actionHeadline": "A String", # The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad. + "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. "heightPixels": 42, # The height in pixels. @@ -341,6 +536,7 @@

Method Details

"actionButtonLabel": "A String", # The text on the call-to-action button. "actionHeadline": "A String", # The headline of the call-to-action banner. "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad. + "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. "heightPixels": 42, # The height in pixels. @@ -378,6 +574,7 @@

Method Details

], "companionBanners": [ # The list of companion banners used by this ad. { # Meta data of an image asset. + "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. "heightPixels": 42, # The height in pixels. @@ -411,19 +608,8 @@

Method Details

}, ], }, -}
-
- -
- list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists ad group ads.
+}
 
-Args:
-  advertiserId: string, Required. The ID of the advertiser the ads belong to. (required)
-  filter: string, Optional. Allows filtering by ad group ad fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `adGroupId` * `displayName` * `entityStatus` * `adGroupAdId` Examples: * All ad group ads under an ad group: `adGroupId="1234"` * All ad group ads under an ad group with an entityStatus of `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED`: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
-  orderBy: string, Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.
-  pageSize: integer, Optional. Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
-  pageToken: string, Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroupAds` method. If not specified, the first page of results will be returned.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -432,330 +618,2598 @@ 

Method Details

Returns: An object of the form: - { - "adGroupAds": [ # The list of ads. This list will be absent if empty. { # A single ad associated with an ad group. - "adGroupAdId": "A String", # Output only. The unique ID of the ad. Assigned by the system. - "adGroupId": "A String", # Required. The unique ID of the ad group that the ad belongs to. - "adPolicy": { # A single ad policy associated with an ad group ad. # Output only. The policy approval status of the ad. - "adPolicyApprovalStatus": "A String", # The policy approval status of an ad, indicating the approval decision. - "adPolicyReviewStatus": "A String", # The policy review status of an ad, indicating where in the review process the ad is currently. - "adPolicyTopicEntry": [ # The entries for each policy topic identified as relating to the ad. Each entry includes the topic, restriction level, and guidance on how to fix policy issues. - { # An entry describing how an ad has been identified as relating to an ad policy. - "appealInfo": { # Information on how to appeal a policy decision. # Information on how to appeal the policy decision. - "appealFormLink": "A String", # Only available when appeal_type is `APPEAL_FORM`. - "appealType": "A String", # Whether the decision can be appealed through a self-service appeal or an appeal form. + "adGroupAdId": "A String", # Output only. The unique ID of the ad. Assigned by the system. + "adGroupId": "A String", # Required. The unique ID of the ad group that the ad belongs to. + "adPolicy": { # A single ad policy associated with an ad group ad. # Output only. The policy approval status of the ad. + "adPolicyApprovalStatus": "A String", # The policy approval status of an ad, indicating the approval decision. + "adPolicyReviewStatus": "A String", # The policy review status of an ad, indicating where in the review process the ad is currently. + "adPolicyTopicEntry": [ # The entries for each policy topic identified as relating to the ad. Each entry includes the topic, restriction level, and guidance on how to fix policy issues. + { # An entry describing how an ad has been identified as relating to an ad policy. + "appealInfo": { # Information on how to appeal a policy decision. # Information on how to appeal the policy decision. + "appealFormLink": "A String", # Only available when appeal_type is `APPEAL_FORM`. + "appealType": "A String", # Whether the decision can be appealed through a self-service appeal or an appeal form. + }, + "helpCenterLink": "A String", # Ad policy help center link for the policy topic. + "policyDecisionType": "A String", # The source of the policy decision. + "policyEnforcementMeans": "A String", # The policy enforcement means used in the policy review. + "policyLabel": "A String", # Localized label text for policy. Examples include "Trademarks in text", "Contains Alcohol", etc. + "policyTopic": "A String", # The policy topic. Examples include "TRADEMARKS", "ALCOHOL", etc. + "policyTopicConstraints": [ # The serving constraints relevant to the policy decision. + { # Details on ad serving constraints. + "certificateDomainMismatchCountryList": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where the resource's domain is not covered by the certificates associated with it. + "countries": [ # Countries where the ad cannot serve. + { # Represents a country restriction. + "countryCriterionId": "A String", # The country criterion id. + "countryLabel": "A String", # Localized name for the country. May be empty. + }, + ], }, - "helpCenterLink": "A String", # Ad policy help center link for the policy topic. - "policyDecisionType": "A String", # The source of the policy decision. - "policyEnforcementMeans": "A String", # The policy enforcement means used in the policy review. - "policyLabel": "A String", # Localized label text for policy. Examples include "Trademarks in text", "Contains Alcohol", etc. - "policyTopic": "A String", # The policy topic. Examples include "TRADEMARKS", "ALCOHOL", etc. - "policyTopicConstraints": [ # The serving constraints relevant to the policy decision. - { # Details on ad serving constraints. - "certificateDomainMismatchCountryList": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where the resource's domain is not covered by the certificates associated with it. - "countries": [ # Countries where the ad cannot serve. - { # Represents a country restriction. - "countryCriterionId": "A String", # The country criterion id. - "countryLabel": "A String", # Localized name for the country. May be empty. - }, - ], + "certificateMissingCountryList": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where a certificate is required for serving. + "countries": [ # Countries where the ad cannot serve. + { # Represents a country restriction. + "countryCriterionId": "A String", # The country criterion id. + "countryLabel": "A String", # Localized name for the country. May be empty. }, - "certificateMissingCountryList": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where a certificate is required for serving. - "countries": [ # Countries where the ad cannot serve. - { # Represents a country restriction. - "countryCriterionId": "A String", # The country criterion id. - "countryLabel": "A String", # Localized name for the country. May be empty. - }, - ], + ], + }, + "countryConstraint": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where the ad cannot serve. + "countries": [ # Countries where the ad cannot serve. + { # Represents a country restriction. + "countryCriterionId": "A String", # The country criterion id. + "countryLabel": "A String", # Localized name for the country. May be empty. }, - "countryConstraint": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where the ad cannot serve. - "countries": [ # Countries where the ad cannot serve. + ], + }, + "globalCertificateDomainMismatch": { # Certificate is required to serve in any country and the existing certificate does not cover the ad's domain. # Certificate is required to serve in any country and the existing certificate does not cover the ad's domain. + }, + "globalCertificateMissing": { # Certificate is required to serve in any country. # Certificate is required to serve in any country. + }, + "requestCertificateFormLink": "A String", # Link to the form to request a certificate for the constraint. + "resellerConstraint": { # Policy topic was constrained due to disapproval of the website for reseller purposes. # Reseller constraint. + }, + }, + ], + "policyTopicDescription": "A String", # A short summary description of the policy topic. + "policyTopicEvidences": [ # The evidence used in the policy decision. + { # Evidence information used in the policy decision. + "counterfeit": { # Details on the counterfeit enforcement that caused a policy violation. # Counterfeit enforcement that caused a policy violation. + "owners": [ # The content or product owners that made a complaint. + "A String", + ], + }, + "destinationMismatch": { # Details on a mismatch between destination URL types. # A mismatch between the ad destination URLs. + "uriTypes": [ # The set of URLs that do not match. The list can include single or multiple uri types. Example 1: [`DISPLAY_URL`, `FINAL_URL`] means ad display URL does not match with the ad final URL. Example 2: [`FINAL_URL`] means ad final URL did not match the crawled url, which is also considered as destination mismatch. + "A String", + ], + }, + "destinationNotWorking": { # Details for on HTTP or DNS errors related to the ad destination. # Information on HTTP or DNS errors related to the ad destination. + "device": "A String", # The device where visiting the URL resulted in the error. + "dnsErrorType": "A String", # The type of DNS error. + "expandedUri": "A String", # The full URL that didn't work. + "httpErrorCode": "A String", # The HTTP error code. + "lastCheckedTime": "A String", # The last time the error was seen when navigating to URL. + }, + "destinationTextList": { # A list of destination text that violated the policy. # The text in the destination of the ad that is causing a policy violation. + "destinationTexts": [ # Destination text that caused the policy finding. + "A String", + ], + }, + "httpCode": 42, # HTTP code returned when the final URL was crawled. + "languageCode": "A String", # The language the ad was detected to be written in. This field uses IETF language tags, such as "en-US". + "legalRemoval": { # Legal related regulation enforcement, either from DMCA or local legal regulation. # Legal related regulation enforcement that caused a policy violation. + "complaintType": "A String", # The type of complaint causing the legal removal. + "countryRestrictions": [ # The countries restricted due to the legal removal. + { # Represents a country restriction. + "countryCriterionId": "A String", # The country criterion id. + "countryLabel": "A String", # Localized name for the country. May be empty. + }, + ], + "dmca": { # DMCA complaint details. # Details on the DMCA regulation legal removal. + "complainant": "A String", # The entity who made the legal complaint. + }, + "localLegal": { # Local legal regulation details. # Details on the local legal regulation legal removal. + "lawType": "A String", # Type of law for the legal notice. + }, + "restrictedUris": [ # The urls restricted due to the legal removal. + "A String", + ], + }, + "regionalRequirements": { # Trust & Safety (T&S) proactive enforcement for policies meant to address regional requirements. This is considered a Google-owned investigation instead of a regulation notice since it's proactive T&S enforcement. # T&S proactive enforcement that caused a policy violation. + "regionalRequirementsEntries": [ # List of regional requirements. + { # Policy level regional legal violation details. + "countryRestrictions": [ # The countries restricted due to the legal policy. { # Represents a country restriction. "countryCriterionId": "A String", # The country criterion id. "countryLabel": "A String", # Localized name for the country. May be empty. }, ], + "legalPolicy": "A String", # The legal policy that is being violated. }, - "globalCertificateDomainMismatch": { # Certificate is required to serve in any country and the existing certificate does not cover the ad's domain. # Certificate is required to serve in any country and the existing certificate does not cover the ad's domain. - }, - "globalCertificateMissing": { # Certificate is required to serve in any country. # Certificate is required to serve in any country. + ], + }, + "textList": { # A list of fragments of text that violated the policy. # List of evidence found in the text of the ad. + "texts": [ # The fragments of text from the resource that caused the policy finding. + "A String", + ], + }, + "trademark": { # Trademark terms that caused a policy violation. # Trademark terms that caused a policy violation. + "countryRestrictions": [ # Countries where the policy violation is relevant. + { # Represents a country restriction. + "countryCriterionId": "A String", # The country criterion id. + "countryLabel": "A String", # Localized name for the country. May be empty. }, - "requestCertificateFormLink": "A String", # Link to the form to request a certificate for the constraint. - "resellerConstraint": { # Policy topic was constrained due to disapproval of the website for reseller purposes. # Reseller constraint. - }, - }, - ], - "policyTopicDescription": "A String", # A short summary description of the policy topic. - "policyTopicEvidences": [ # The evidence used in the policy decision. - { # Evidence information used in the policy decision. - "counterfeit": { # Details on the counterfeit enforcement that caused a policy violation. # Counterfeit enforcement that caused a policy violation. - "owners": [ # The content or product owners that made a complaint. - "A String", - ], - }, - "destinationMismatch": { # Details on a mismatch between destination URL types. # A mismatch between the ad destination URLs. - "uriTypes": [ # The set of URLs that do not match. The list can include single or multiple uri types. Example 1: [`DISPLAY_URL`, `FINAL_URL`] means ad display URL does not match with the ad final URL. Example 2: [`FINAL_URL`] means ad final URL did not match the crawled url, which is also considered as destination mismatch. - "A String", - ], - }, - "destinationNotWorking": { # Details for on HTTP or DNS errors related to the ad destination. # Information on HTTP or DNS errors related to the ad destination. - "device": "A String", # The device where visiting the URL resulted in the error. - "dnsErrorType": "A String", # The type of DNS error. - "expandedUri": "A String", # The full URL that didn't work. - "httpErrorCode": "A String", # The HTTP error code. - "lastCheckedTime": "A String", # The last time the error was seen when navigating to URL. - }, - "destinationTextList": { # A list of destination text that violated the policy. # The text in the destination of the ad that is causing a policy violation. - "destinationTexts": [ # Destination text that caused the policy finding. - "A String", - ], - }, - "httpCode": 42, # HTTP code returned when the final URL was crawled. - "languageCode": "A String", # The language the ad was detected to be written in. This field uses IETF language tags, such as "en-US". - "legalRemoval": { # Legal related regulation enforcement, either from DMCA or local legal regulation. # Legal related regulation enforcement that caused a policy violation. - "complaintType": "A String", # The type of complaint causing the legal removal. - "countryRestrictions": [ # The countries restricted due to the legal removal. - { # Represents a country restriction. - "countryCriterionId": "A String", # The country criterion id. - "countryLabel": "A String", # Localized name for the country. May be empty. - }, - ], - "dmca": { # DMCA complaint details. # Details on the DMCA regulation legal removal. - "complainant": "A String", # The entity who made the legal complaint. - }, - "localLegal": { # Local legal regulation details. # Details on the local legal regulation legal removal. - "lawType": "A String", # Type of law for the legal notice. - }, - "restrictedUris": [ # The urls restricted due to the legal removal. - "A String", - ], - }, - "regionalRequirements": { # Trust & Safety (T&S) proactive enforcement for policies meant to address regional requirements. This is considered a Google-owned investigation instead of a regulation notice since it's proactive T&S enforcement. # T&S proactive enforcement that caused a policy violation. - "regionalRequirementsEntries": [ # List of regional requirements. - { # Policy level regional legal violation details. - "countryRestrictions": [ # The countries restricted due to the legal policy. - { # Represents a country restriction. - "countryCriterionId": "A String", # The country criterion id. - "countryLabel": "A String", # Localized name for the country. May be empty. - }, - ], - "legalPolicy": "A String", # The legal policy that is being violated. - }, - ], - }, - "textList": { # A list of fragments of text that violated the policy. # List of evidence found in the text of the ad. - "texts": [ # The fragments of text from the resource that caused the policy finding. - "A String", - ], - }, - "trademark": { # Trademark terms that caused a policy violation. # Trademark terms that caused a policy violation. - "countryRestrictions": [ # Countries where the policy violation is relevant. - { # Represents a country restriction. - "countryCriterionId": "A String", # The country criterion id. - "countryLabel": "A String", # Localized name for the country. May be empty. - }, - ], - "owner": "A String", # The trademark content owner. - "term": "A String", # The trademark term. - }, - "websiteList": { # A list of websites that violated the policy. # List of websites linked with the ad. - "websites": [ # Websites that caused the policy finding. - "A String", - ], - }, - }, - ], - "policyTopicType": "A String", # How ad serving will be affected due to the relation to the ad policy topic. + ], + "owner": "A String", # The trademark content owner. + "term": "A String", # The trademark term. + }, + "websiteList": { # A list of websites that violated the policy. # List of websites linked with the ad. + "websites": [ # Websites that caused the policy finding. + "A String", + ], + }, }, ], + "policyTopicType": "A String", # How ad serving will be affected due to the relation to the ad policy topic. }, - "adUrls": [ # Output only. List of URLs used by the ad. - { # Additional URLs related to the ad, including beacons. - "type": "A String", # The type of the Ad URL. - "url": "A String", # The URL string value. - }, - ], - "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad belongs to. - "audioAd": { # Details for an audio ad. # Output only. Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives. - "displayUrl": "A String", # The webpage address that appears with the ad. - "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. - "video": { # Details of a YouTube video. # The YouTube video of the ad. - "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. - "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + ], + }, + "adUrls": [ # Output only. List of URLs used by the ad. + { # Additional URLs related to the ad, including beacons. + "type": "A String", # The type of the Ad URL. + "url": "A String", # The URL string value. + }, + ], + "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad belongs to. + "audioAd": { # Details for an audio ad. # Output only. Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives. + "displayUrl": "A String", # The webpage address that appears with the ad. + "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad. + "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. + "video": { # Details of a YouTube video. # The YouTube video of the ad. + "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. + "unavailableReason": "A String", # The reason why the video data is not available. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + }, + }, + "bumperAd": { # Details for a bumper ad. # Output only. Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach. + "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes. + "actionButtonLabel": "A String", # The text on the call-to-action button. + "actionHeadline": "A String", # The headline of the call-to-action banner. + "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. }, + "mimeType": "A String", # Output only. MIME type of the image asset. }, - "bumperAd": { # Details for a bumper ad. # Output only. Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach. - "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes. - "actionButtonLabel": "A String", # The text on the call-to-action button. - "actionHeadline": "A String", # The headline of the call-to-action banner. - "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad. - "fileSize": "A String", # Output only. File size of the image asset in bytes. - "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. - "heightPixels": 42, # The height in pixels. - "widthPixels": 42, # The width in pixels. - }, - "mimeType": "A String", # Output only. MIME type of the image asset. + "displayUrl": "A String", # The webpage address that appears with the ad. + "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad. + "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. + "video": { # Details of a YouTube video. # The YouTube video of the ad. + "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. + "unavailableReason": "A String", # The reason why the video data is not available. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + }, + }, + }, + "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). + "businessName": "A String", # Required. The business name shown on the ad. + "cards": [ # Required. The list of cards shown on the ad. + { # Details for a Demand Gen carousel card. + "callToAction": "A String", # Required. The call-to-action button shown on the card. Must use 10 characters or less. + "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the card on a mobile device. + "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the card. + "headline": "A String", # Required. The headline of the card. + "marketingImage": { # Meta data of an image asset. # Optional. The marketing image shown on the card. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. }, - "displayUrl": "A String", # The webpage address that appears with the ad. - "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. - "video": { # Details of a YouTube video. # The YouTube video of the ad. - "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. - "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "mimeType": "A String", # Output only. MIME type of the image asset. + }, + "portraitMarketingImage": { # Meta data of an image asset. # Optional. The portrait marketing image shown on the card. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. + }, + "mimeType": "A String", # Output only. MIME type of the image asset. + }, + "squareMarketingImage": { # Meta data of an image asset. # Optional. The square marketing image shown on the card. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. }, + "mimeType": "A String", # Output only. MIME type of the image asset. }, }, - "displayName": "A String", # Required. The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes. - "displayVideoSourceAd": { # The ad sourced from a DV360 creative. # Output only. Details of an ad sourced from a Display & Video 360 creative. - "creativeId": "A String", # The ID of the source creative. + ], + "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "a_key": "A String", + }, + "description": "A String", # Required. The description of the ad. + "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. + "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. + "headline": "A String", # Required. The headline of the ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. }, - "entityStatus": "A String", # Required. The entity status of the ad. - "inStreamAd": { # Details for an in-stream ad. # Output only. Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives. - "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes. - "actionButtonLabel": "A String", # The text on the call-to-action button. - "actionHeadline": "A String", # The headline of the call-to-action banner. - "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad. - "fileSize": "A String", # Output only. File size of the image asset in bytes. - "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. - "heightPixels": 42, # The height in pixels. - "widthPixels": 42, # The width in pixels. - }, - "mimeType": "A String", # Output only. MIME type of the image asset. - }, - "displayUrl": "A String", # The webpage address that appears with the ad. - "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. - "video": { # Details of a YouTube video. # The YouTube video of the ad. - "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. - "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. - }, + "mimeType": "A String", # Output only. MIME type of the image asset. + }, + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. + }, + "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). + "businessName": "A String", # Required. The business name shown on the ad. + "callToAction": "A String", # Required. The call-to-action button shown on the ad. + "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "a_key": "A String", + }, + "descriptions": [ # Required. The list of descriptions shown on the ad. + "A String", + ], + "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the ad on a mobile device. + "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. + "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. + "headlines": [ # Required. The list of headlines shown on the ad. + "A String", + ], + "logoImages": [ # The list of logo images shown on the ad. + { # Meta data of an image asset. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. }, - "customParameters": { # The custom parameters to pass custom values to tracking URL template. - "a_key": "A String", + "mimeType": "A String", # Output only. MIME type of the image asset. + }, + ], + "marketingImages": [ # The list of marketing images shown on the ad. + { # Meta data of an image asset. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. }, + "mimeType": "A String", # Output only. MIME type of the image asset. }, - "mastheadAd": { # Details for a Masthead Ad. # Output only. Details of an [ad served on the YouTube Home feed](//support.google.com/google-ads/answer/9709826). - "autoplayVideoDuration": "A String", # The duration of time the video will autoplay. - "autoplayVideoStartMillisecond": "A String", # The amount of time in milliseconds after which the video will start to play. - "callToActionButtonLabel": "A String", # The text on the call-to-action button. - "callToActionFinalUrl": "A String", # The destination URL for the call-to-action button. - "callToActionTrackingUrl": "A String", # The tracking URL for the call-to-action button. - "companionYoutubeVideos": [ # The videos that appear next to the Masthead Ad on desktop. Can be no more than two. - { # Details of a YouTube video. - "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. - "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. - }, - ], - "description": "A String", # The description of the ad. - "headline": "A String", # The headline of the ad. - "showChannelArt": True or False, # Whether to show a background or banner that appears at the top of a YouTube page. - "video": { # Details of a YouTube video. # The YouTube video used by the ad. - "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. - "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + ], + "portraitMarketingImages": [ # The list of portrait marketing images shown on the ad. + { # Meta data of an image asset. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. }, - "videoAspectRatio": "A String", # The aspect ratio of the autoplaying YouTube video on the Masthead. + "mimeType": "A String", # Output only. MIME type of the image asset. }, - "name": "A String", # Output only. The resource name of the ad. - "nonSkippableAd": { # Details for a non-skippable ad. # Output only. Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives. - "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes. - "actionButtonLabel": "A String", # The text on the call-to-action button. - "actionHeadline": "A String", # The headline of the call-to-action banner. - "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad. - "fileSize": "A String", # Output only. File size of the image asset in bytes. - "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. - "heightPixels": 42, # The height in pixels. - "widthPixels": 42, # The width in pixels. - }, - "mimeType": "A String", # Output only. MIME type of the image asset. - }, - "displayUrl": "A String", # The webpage address that appears with the ad. - "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad. - "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. - "video": { # Details of a YouTube video. # The YouTube video of the ad. - "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. - "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. - }, + ], + "squareMarketingImages": [ # The list of square marketing images shown on the ad. + { # Meta data of an image asset. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. }, - "customParameters": { # The custom parameters to pass custom values to tracking URL template. - "a_key": "A String", + "mimeType": "A String", # Output only. MIME type of the image asset. + }, + ], + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. + }, + "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). + "businessName": "A String", # Required. The business name shown on the ad. + "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` + "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "a_key": "A String", + }, + "description": "A String", # Required. The description of the ad. + "displayUrlBreadcrumb1": "A String", # Optional. The first piece after the domain in the display URL. + "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL. + "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. + "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. + "headline": "A String", # Required. The headline of the ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. + }, + "mimeType": "A String", # Output only. MIME type of the image asset. + }, + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. + }, + "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). + "businessName": "A String", # Required. The business name shown on the ad. + "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` + "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. + }, + "mimeType": "A String", # Output only. MIME type of the image asset. + }, + "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "a_key": "A String", + }, + "descriptions": [ # Required. The list of descriptions shown on the ad. + "A String", + ], + "displayUrlBreadcrumb1": "A String", # Optional. The first piece after the domain in the display URL. + "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL. + "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the ad on a mobile device. + "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. + "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. + "headlines": [ # Required. The list of headlines shown on the ad. + "A String", + ], + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. + }, + "mimeType": "A String", # Output only. MIME type of the image asset. + }, + "longHeadlines": [ # Required. The list of lone headlines shown on the ad. + "A String", + ], + "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. + "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. + "videos": [ # Required. The list of YouTube video assets used by this ad. + { # Details of a YouTube video. + "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. + "unavailableReason": "A String", # The reason why the video data is not available. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + }, + ], + }, + "displayName": "A String", # Required. The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes. + "displayVideoSourceAd": { # The ad sourced from a DV360 creative. # Output only. Details of an ad sourced from a Display & Video 360 creative. + "creativeId": "A String", # The ID of the source creative. + }, + "entityStatus": "A String", # Required. The entity status of the ad. + "inStreamAd": { # Details for an in-stream ad. # Output only. Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives. + "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes. + "actionButtonLabel": "A String", # The text on the call-to-action button. + "actionHeadline": "A String", # The headline of the call-to-action banner. + "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. }, + "mimeType": "A String", # Output only. MIME type of the image asset. }, - "videoDiscoverAd": { # Details for a video discovery ad. # Output only. Details of an [ad promoting a video](//support.google.com/displayvideo/answer/6274216) that shows in places of discovery. - "description1": "A String", # First text line for the ad. - "description2": "A String", # Second text line for the ad. - "headline": "A String", # The headline of ad. - "thumbnail": "A String", # Thumbnail image used in the ad. - "video": { # Details of a YouTube video. # The YouTube video the ad promotes. - "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. - "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "displayUrl": "A String", # The webpage address that appears with the ad. + "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad. + "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. + "video": { # Details of a YouTube video. # The YouTube video of the ad. + "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. + "unavailableReason": "A String", # The reason why the video data is not available. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + }, + }, + "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "a_key": "A String", + }, + }, + "mastheadAd": { # Details for a Masthead Ad. # Output only. Details of an [ad served on the YouTube Home feed](//support.google.com/google-ads/answer/9709826). + "autoplayVideoDuration": "A String", # The duration of time the video will autoplay. + "autoplayVideoStartMillisecond": "A String", # The amount of time in milliseconds after which the video will start to play. + "callToActionButtonLabel": "A String", # The text on the call-to-action button. + "callToActionFinalUrl": "A String", # The destination URL for the call-to-action button. + "callToActionTrackingUrl": "A String", # The tracking URL for the call-to-action button. + "companionYoutubeVideos": [ # The videos that appear next to the Masthead Ad on desktop. Can be no more than two. + { # Details of a YouTube video. + "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. + "unavailableReason": "A String", # The reason why the video data is not available. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + }, + ], + "description": "A String", # The description of the ad. + "headline": "A String", # The headline of the ad. + "showChannelArt": True or False, # Whether to show a background or banner that appears at the top of a YouTube page. + "video": { # Details of a YouTube video. # The YouTube video used by the ad. + "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. + "unavailableReason": "A String", # The reason why the video data is not available. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + }, + "videoAspectRatio": "A String", # The aspect ratio of the autoplaying YouTube video on the Masthead. + }, + "name": "A String", # Output only. The resource name of the ad. + "nonSkippableAd": { # Details for a non-skippable ad. # Output only. Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives. + "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes. + "actionButtonLabel": "A String", # The text on the call-to-action button. + "actionHeadline": "A String", # The headline of the call-to-action banner. + "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. }, + "mimeType": "A String", # Output only. MIME type of the image asset. }, - "videoPerformanceAd": { # Details for a video performance ad. # Output only. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product. - "actionButtonLabels": [ # The list of text assets shown on the call-to-action button. - "A String", - ], - "companionBanners": [ # The list of companion banners used by this ad. - { # Meta data of an image asset. - "fileSize": "A String", # Output only. File size of the image asset in bytes. - "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. - "heightPixels": 42, # The height in pixels. - "widthPixels": 42, # The width in pixels. - }, - "mimeType": "A String", # Output only. MIME type of the image asset. - }, - ], - "customParameters": { # The custom parameters to pass custom values to tracking URL template. - "a_key": "A String", + "displayUrl": "A String", # The webpage address that appears with the ad. + "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad. + "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. + "video": { # Details of a YouTube video. # The YouTube video of the ad. + "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. + "unavailableReason": "A String", # The reason why the video data is not available. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + }, + }, + "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "a_key": "A String", + }, + }, + "videoDiscoverAd": { # Details for a video discovery ad. # Output only. Details of an [ad promoting a video](//support.google.com/displayvideo/answer/6274216) that shows in places of discovery. + "description1": "A String", # First text line for the ad. + "description2": "A String", # Second text line for the ad. + "headline": "A String", # The headline of ad. + "thumbnail": "A String", # Thumbnail image used in the ad. + "video": { # Details of a YouTube video. # The YouTube video the ad promotes. + "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. + "unavailableReason": "A String", # The reason why the video data is not available. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + }, + }, + "videoPerformanceAd": { # Details for a video performance ad. # Output only. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product. + "actionButtonLabels": [ # The list of text assets shown on the call-to-action button. + "A String", + ], + "companionBanners": [ # The list of companion banners used by this ad. + { # Meta data of an image asset. + "assetId": "A String", # Required. The unique ID of the asset. + "fileSize": "A String", # Output only. File size of the image asset in bytes. + "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. + "heightPixels": 42, # The height in pixels. + "widthPixels": 42, # The width in pixels. }, - "descriptions": [ # The list of descriptions shown on the call-to-action banner. - "A String", - ], - "displayUrlBreadcrumb1": "A String", # The first piece after the domain in the display URL. - "displayUrlBreadcrumb2": "A String", # The second piece after the domain in the display URL. - "domain": "A String", # The domain of the display URL. - "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad. - "headlines": [ # The list of headlines shown on the call-to-action banner. - "A String", - ], - "longHeadlines": [ # The list of lone headlines shown on the call-to-action banner. - "A String", - ], - "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. - "videos": [ # The list of YouTube video assets used by this ad. - { # Details of a YouTube video. - "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. - "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. - }, - ], + "mimeType": "A String", # Output only. MIME type of the image asset. }, + ], + "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "a_key": "A String", }, - ], - "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAdGroupAds` method to retrieve the next page of results. + "descriptions": [ # The list of descriptions shown on the call-to-action banner. + "A String", + ], + "displayUrlBreadcrumb1": "A String", # The first piece after the domain in the display URL. + "displayUrlBreadcrumb2": "A String", # The second piece after the domain in the display URL. + "domain": "A String", # The domain of the display URL. + "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad. + "headlines": [ # The list of headlines shown on the call-to-action banner. + "A String", + ], + "longHeadlines": [ # The list of lone headlines shown on the call-to-action banner. + "A String", + ], + "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. + "videos": [ # The list of YouTube video assets used by this ad. + { # Details of a YouTube video. + "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. + "unavailableReason": "A String", # The reason why the video data is not available. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + }, + ], + }, }
- list_next() -
Retrieves the next page of results.
+    delete(advertiserId, adGroupAdId, x__xgafv=None)
+  
Deletes an ad group ad.
 
-        Args:
-          previous_request: The request for the previous page. (required)
-          previous_response: The response from the request for the previous page. (required)
+Args:
+  advertiserId: string, Required. The ID of the advertiser the ad belongs to. (required)
+  adGroupAdId: string, Required. The ID of the ad to delete. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
 
-        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.
-        
+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(advertiserId, adGroupAdId, x__xgafv=None) +
Gets an ad group ad.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser this ad group ad belongs to. (required)
+  adGroupAdId: string, Required. The ID of the ad to fetch. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single ad associated with an ad group.
+  "adGroupAdId": "A String", # Output only. The unique ID of the ad. Assigned by the system.
+  "adGroupId": "A String", # Required. The unique ID of the ad group that the ad belongs to.
+  "adPolicy": { # A single ad policy associated with an ad group ad. # Output only. The policy approval status of the ad.
+    "adPolicyApprovalStatus": "A String", # The policy approval status of an ad, indicating the approval decision.
+    "adPolicyReviewStatus": "A String", # The policy review status of an ad, indicating where in the review process the ad is currently.
+    "adPolicyTopicEntry": [ # The entries for each policy topic identified as relating to the ad. Each entry includes the topic, restriction level, and guidance on how to fix policy issues.
+      { # An entry describing how an ad has been identified as relating to an ad policy.
+        "appealInfo": { # Information on how to appeal a policy decision. # Information on how to appeal the policy decision.
+          "appealFormLink": "A String", # Only available when appeal_type is `APPEAL_FORM`.
+          "appealType": "A String", # Whether the decision can be appealed through a self-service appeal or an appeal form.
+        },
+        "helpCenterLink": "A String", # Ad policy help center link for the policy topic.
+        "policyDecisionType": "A String", # The source of the policy decision.
+        "policyEnforcementMeans": "A String", # The policy enforcement means used in the policy review.
+        "policyLabel": "A String", # Localized label text for policy. Examples include "Trademarks in text", "Contains Alcohol", etc.
+        "policyTopic": "A String", # The policy topic. Examples include "TRADEMARKS", "ALCOHOL", etc.
+        "policyTopicConstraints": [ # The serving constraints relevant to the policy decision.
+          { # Details on ad serving constraints.
+            "certificateDomainMismatchCountryList": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where the resource's domain is not covered by the certificates associated with it.
+              "countries": [ # Countries where the ad cannot serve.
+                { # Represents a country restriction.
+                  "countryCriterionId": "A String", # The country criterion id.
+                  "countryLabel": "A String", # Localized name for the country. May be empty.
+                },
+              ],
+            },
+            "certificateMissingCountryList": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where a certificate is required for serving.
+              "countries": [ # Countries where the ad cannot serve.
+                { # Represents a country restriction.
+                  "countryCriterionId": "A String", # The country criterion id.
+                  "countryLabel": "A String", # Localized name for the country. May be empty.
+                },
+              ],
+            },
+            "countryConstraint": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where the ad cannot serve.
+              "countries": [ # Countries where the ad cannot serve.
+                { # Represents a country restriction.
+                  "countryCriterionId": "A String", # The country criterion id.
+                  "countryLabel": "A String", # Localized name for the country. May be empty.
+                },
+              ],
+            },
+            "globalCertificateDomainMismatch": { # Certificate is required to serve in any country and the existing certificate does not cover the ad's domain. # Certificate is required to serve in any country and the existing certificate does not cover the ad's domain.
+            },
+            "globalCertificateMissing": { # Certificate is required to serve in any country. # Certificate is required to serve in any country.
+            },
+            "requestCertificateFormLink": "A String", # Link to the form to request a certificate for the constraint.
+            "resellerConstraint": { # Policy topic was constrained due to disapproval of the website for reseller purposes. # Reseller constraint.
+            },
+          },
+        ],
+        "policyTopicDescription": "A String", # A short summary description of the policy topic.
+        "policyTopicEvidences": [ # The evidence used in the policy decision.
+          { # Evidence information used in the policy decision.
+            "counterfeit": { # Details on the counterfeit enforcement that caused a policy violation. # Counterfeit enforcement that caused a policy violation.
+              "owners": [ # The content or product owners that made a complaint.
+                "A String",
+              ],
+            },
+            "destinationMismatch": { # Details on a mismatch between destination URL types. # A mismatch between the ad destination URLs.
+              "uriTypes": [ # The set of URLs that do not match. The list can include single or multiple uri types. Example 1: [`DISPLAY_URL`, `FINAL_URL`] means ad display URL does not match with the ad final URL. Example 2: [`FINAL_URL`] means ad final URL did not match the crawled url, which is also considered as destination mismatch.
+                "A String",
+              ],
+            },
+            "destinationNotWorking": { # Details for on HTTP or DNS errors related to the ad destination. # Information on HTTP or DNS errors related to the ad destination.
+              "device": "A String", # The device where visiting the URL resulted in the error.
+              "dnsErrorType": "A String", # The type of DNS error.
+              "expandedUri": "A String", # The full URL that didn't work.
+              "httpErrorCode": "A String", # The HTTP error code.
+              "lastCheckedTime": "A String", # The last time the error was seen when navigating to URL.
+            },
+            "destinationTextList": { # A list of destination text that violated the policy. # The text in the destination of the ad that is causing a policy violation.
+              "destinationTexts": [ # Destination text that caused the policy finding.
+                "A String",
+              ],
+            },
+            "httpCode": 42, # HTTP code returned when the final URL was crawled.
+            "languageCode": "A String", # The language the ad was detected to be written in. This field uses IETF language tags, such as "en-US".
+            "legalRemoval": { # Legal related regulation enforcement, either from DMCA or local legal regulation. # Legal related regulation enforcement that caused a policy violation.
+              "complaintType": "A String", # The type of complaint causing the legal removal.
+              "countryRestrictions": [ # The countries restricted due to the legal removal.
+                { # Represents a country restriction.
+                  "countryCriterionId": "A String", # The country criterion id.
+                  "countryLabel": "A String", # Localized name for the country. May be empty.
+                },
+              ],
+              "dmca": { # DMCA complaint details. # Details on the DMCA regulation legal removal.
+                "complainant": "A String", # The entity who made the legal complaint.
+              },
+              "localLegal": { # Local legal regulation details. # Details on the local legal regulation legal removal.
+                "lawType": "A String", # Type of law for the legal notice.
+              },
+              "restrictedUris": [ # The urls restricted due to the legal removal.
+                "A String",
+              ],
+            },
+            "regionalRequirements": { # Trust & Safety (T&S) proactive enforcement for policies meant to address regional requirements. This is considered a Google-owned investigation instead of a regulation notice since it's proactive T&S enforcement. # T&S proactive enforcement that caused a policy violation.
+              "regionalRequirementsEntries": [ # List of regional requirements.
+                { # Policy level regional legal violation details.
+                  "countryRestrictions": [ # The countries restricted due to the legal policy.
+                    { # Represents a country restriction.
+                      "countryCriterionId": "A String", # The country criterion id.
+                      "countryLabel": "A String", # Localized name for the country. May be empty.
+                    },
+                  ],
+                  "legalPolicy": "A String", # The legal policy that is being violated.
+                },
+              ],
+            },
+            "textList": { # A list of fragments of text that violated the policy. # List of evidence found in the text of the ad.
+              "texts": [ # The fragments of text from the resource that caused the policy finding.
+                "A String",
+              ],
+            },
+            "trademark": { # Trademark terms that caused a policy violation. # Trademark terms that caused a policy violation.
+              "countryRestrictions": [ # Countries where the policy violation is relevant.
+                { # Represents a country restriction.
+                  "countryCriterionId": "A String", # The country criterion id.
+                  "countryLabel": "A String", # Localized name for the country. May be empty.
+                },
+              ],
+              "owner": "A String", # The trademark content owner.
+              "term": "A String", # The trademark term.
+            },
+            "websiteList": { # A list of websites that violated the policy. # List of websites linked with the ad.
+              "websites": [ # Websites that caused the policy finding.
+                "A String",
+              ],
+            },
+          },
+        ],
+        "policyTopicType": "A String", # How ad serving will be affected due to the relation to the ad policy topic.
+      },
+    ],
+  },
+  "adUrls": [ # Output only. List of URLs used by the ad.
+    { # Additional URLs related to the ad, including beacons.
+      "type": "A String", # The type of the Ad URL.
+      "url": "A String", # The URL string value.
+    },
+  ],
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad belongs to.
+  "audioAd": { # Details for an audio ad. # Output only. Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives.
+    "displayUrl": "A String", # The webpage address that appears with the ad.
+    "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+    "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+    "video": { # Details of a YouTube video. # The YouTube video of the ad.
+      "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+      "unavailableReason": "A String", # The reason why the video data is not available.
+      "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+    },
+  },
+  "bumperAd": { # Details for a bumper ad. # Output only. Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach.
+    "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
+      "actionButtonLabel": "A String", # The text on the call-to-action button.
+      "actionHeadline": "A String", # The headline of the call-to-action banner.
+      "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+      "displayUrl": "A String", # The webpage address that appears with the ad.
+      "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+      "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+      "video": { # Details of a YouTube video. # The YouTube video of the ad.
+        "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+        "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+      },
+    },
+  },
+  "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd).
+    "businessName": "A String", # Required. The business name shown on the ad.
+    "cards": [ # Required. The list of cards shown on the ad.
+      { # Details for a Demand Gen carousel card.
+        "callToAction": "A String", # Required. The call-to-action button shown on the card. Must use 10 characters or less.
+        "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the card on a mobile device.
+        "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the card.
+        "headline": "A String", # Required. The headline of the card.
+        "marketingImage": { # Meta data of an image asset. # Optional. The marketing image shown on the card.
+          "assetId": "A String", # Required. The unique ID of the asset.
+          "fileSize": "A String", # Output only. File size of the image asset in bytes.
+          "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+            "heightPixels": 42, # The height in pixels.
+            "widthPixels": 42, # The width in pixels.
+          },
+          "mimeType": "A String", # Output only. MIME type of the image asset.
+        },
+        "portraitMarketingImage": { # Meta data of an image asset. # Optional. The portrait marketing image shown on the card.
+          "assetId": "A String", # Required. The unique ID of the asset.
+          "fileSize": "A String", # Output only. File size of the image asset in bytes.
+          "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+            "heightPixels": 42, # The height in pixels.
+            "widthPixels": 42, # The width in pixels.
+          },
+          "mimeType": "A String", # Output only. MIME type of the image asset.
+        },
+        "squareMarketingImage": { # Meta data of an image asset. # Optional. The square marketing image shown on the card.
+          "assetId": "A String", # Required. The unique ID of the asset.
+          "fileSize": "A String", # Output only. File size of the image asset in bytes.
+          "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+            "heightPixels": 42, # The height in pixels.
+            "widthPixels": 42, # The width in pixels.
+          },
+          "mimeType": "A String", # Output only. MIME type of the image asset.
+        },
+      },
+    ],
+    "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+    "description": "A String", # Required. The description of the ad.
+    "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad.
+    "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs.
+    "headline": "A String", # Required. The headline of the ad.
+    "logo": { # Meta data of an image asset. # Required. The logo image used by this ad.
+      "assetId": "A String", # Required. The unique ID of the asset.
+      "fileSize": "A String", # Output only. File size of the image asset in bytes.
+      "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+        "heightPixels": 42, # The height in pixels.
+        "widthPixels": 42, # The width in pixels.
+      },
+      "mimeType": "A String", # Output only. MIME type of the image asset.
+    },
+    "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes.
+    "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually.
+  },
+  "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd).
+    "businessName": "A String", # Required. The business name shown on the ad.
+    "callToAction": "A String", # Required. The call-to-action button shown on the ad.
+    "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+    "descriptions": [ # Required. The list of descriptions shown on the ad.
+      "A String",
+    ],
+    "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the ad on a mobile device.
+    "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad.
+    "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs.
+    "headlines": [ # Required. The list of headlines shown on the ad.
+      "A String",
+    ],
+    "logoImages": [ # The list of logo images shown on the ad.
+      { # Meta data of an image asset.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+    ],
+    "marketingImages": [ # The list of marketing images shown on the ad.
+      { # Meta data of an image asset.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+    ],
+    "portraitMarketingImages": [ # The list of portrait marketing images shown on the ad.
+      { # Meta data of an image asset.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+    ],
+    "squareMarketingImages": [ # The list of square marketing images shown on the ad.
+      { # Meta data of an image asset.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+    ],
+    "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes.
+    "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually.
+  },
+  "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd).
+    "businessName": "A String", # Required. The business name shown on the ad.
+    "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE`
+    "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+    "description": "A String", # Required. The description of the ad.
+    "displayUrlBreadcrumb1": "A String", # Optional. The first piece after the domain in the display URL.
+    "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL.
+    "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad.
+    "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs.
+    "headline": "A String", # Required. The headline of the ad.
+    "logo": { # Meta data of an image asset. # Required. The logo image used by this ad.
+      "assetId": "A String", # Required. The unique ID of the asset.
+      "fileSize": "A String", # Output only. File size of the image asset in bytes.
+      "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+        "heightPixels": 42, # The height in pixels.
+        "widthPixels": 42, # The width in pixels.
+      },
+      "mimeType": "A String", # Output only. MIME type of the image asset.
+    },
+    "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes.
+    "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually.
+  },
+  "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd).
+    "businessName": "A String", # Required. The business name shown on the ad.
+    "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW`
+    "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad.
+      "assetId": "A String", # Required. The unique ID of the asset.
+      "fileSize": "A String", # Output only. File size of the image asset in bytes.
+      "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+        "heightPixels": 42, # The height in pixels.
+        "widthPixels": 42, # The width in pixels.
+      },
+      "mimeType": "A String", # Output only. MIME type of the image asset.
+    },
+    "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+    "descriptions": [ # Required. The list of descriptions shown on the ad.
+      "A String",
+    ],
+    "displayUrlBreadcrumb1": "A String", # Optional. The first piece after the domain in the display URL.
+    "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL.
+    "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the ad on a mobile device.
+    "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad.
+    "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs.
+    "headlines": [ # Required. The list of headlines shown on the ad.
+      "A String",
+    ],
+    "logo": { # Meta data of an image asset. # Required. The logo image used by this ad.
+      "assetId": "A String", # Required. The unique ID of the asset.
+      "fileSize": "A String", # Output only. File size of the image asset in bytes.
+      "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+        "heightPixels": 42, # The height in pixels.
+        "widthPixels": 42, # The width in pixels.
+      },
+      "mimeType": "A String", # Output only. MIME type of the image asset.
+    },
+    "longHeadlines": [ # Required. The list of lone headlines shown on the ad.
+      "A String",
+    ],
+    "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes.
+    "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually.
+    "videos": [ # Required. The list of YouTube video assets used by this ad.
+      { # Details of a YouTube video.
+        "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+        "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+      },
+    ],
+  },
+  "displayName": "A String", # Required. The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes.
+  "displayVideoSourceAd": { # The ad sourced from a DV360 creative. # Output only. Details of an ad sourced from a Display & Video 360 creative.
+    "creativeId": "A String", # The ID of the source creative.
+  },
+  "entityStatus": "A String", # Required. The entity status of the ad.
+  "inStreamAd": { # Details for an in-stream ad. # Output only. Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives.
+    "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
+      "actionButtonLabel": "A String", # The text on the call-to-action button.
+      "actionHeadline": "A String", # The headline of the call-to-action banner.
+      "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+      "displayUrl": "A String", # The webpage address that appears with the ad.
+      "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+      "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+      "video": { # Details of a YouTube video. # The YouTube video of the ad.
+        "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+        "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+      },
+    },
+    "customParameters": { # The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+  },
+  "mastheadAd": { # Details for a Masthead Ad. # Output only. Details of an [ad served on the YouTube Home feed](//support.google.com/google-ads/answer/9709826).
+    "autoplayVideoDuration": "A String", # The duration of time the video will autoplay.
+    "autoplayVideoStartMillisecond": "A String", # The amount of time in milliseconds after which the video will start to play.
+    "callToActionButtonLabel": "A String", # The text on the call-to-action button.
+    "callToActionFinalUrl": "A String", # The destination URL for the call-to-action button.
+    "callToActionTrackingUrl": "A String", # The tracking URL for the call-to-action button.
+    "companionYoutubeVideos": [ # The videos that appear next to the Masthead Ad on desktop. Can be no more than two.
+      { # Details of a YouTube video.
+        "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+        "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+      },
+    ],
+    "description": "A String", # The description of the ad.
+    "headline": "A String", # The headline of the ad.
+    "showChannelArt": True or False, # Whether to show a background or banner that appears at the top of a YouTube page.
+    "video": { # Details of a YouTube video. # The YouTube video used by the ad.
+      "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+      "unavailableReason": "A String", # The reason why the video data is not available.
+      "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+    },
+    "videoAspectRatio": "A String", # The aspect ratio of the autoplaying YouTube video on the Masthead.
+  },
+  "name": "A String", # Output only. The resource name of the ad.
+  "nonSkippableAd": { # Details for a non-skippable ad. # Output only. Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives.
+    "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
+      "actionButtonLabel": "A String", # The text on the call-to-action button.
+      "actionHeadline": "A String", # The headline of the call-to-action banner.
+      "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+      "displayUrl": "A String", # The webpage address that appears with the ad.
+      "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+      "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+      "video": { # Details of a YouTube video. # The YouTube video of the ad.
+        "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+        "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+      },
+    },
+    "customParameters": { # The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+  },
+  "videoDiscoverAd": { # Details for a video discovery ad. # Output only. Details of an [ad promoting a video](//support.google.com/displayvideo/answer/6274216) that shows in places of discovery.
+    "description1": "A String", # First text line for the ad.
+    "description2": "A String", # Second text line for the ad.
+    "headline": "A String", # The headline of ad.
+    "thumbnail": "A String", # Thumbnail image used in the ad.
+    "video": { # Details of a YouTube video. # The YouTube video the ad promotes.
+      "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+      "unavailableReason": "A String", # The reason why the video data is not available.
+      "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+    },
+  },
+  "videoPerformanceAd": { # Details for a video performance ad. # Output only. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product.
+    "actionButtonLabels": [ # The list of text assets shown on the call-to-action button.
+      "A String",
+    ],
+    "companionBanners": [ # The list of companion banners used by this ad.
+      { # Meta data of an image asset.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+    ],
+    "customParameters": { # The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+    "descriptions": [ # The list of descriptions shown on the call-to-action banner.
+      "A String",
+    ],
+    "displayUrlBreadcrumb1": "A String", # The first piece after the domain in the display URL.
+    "displayUrlBreadcrumb2": "A String", # The second piece after the domain in the display URL.
+    "domain": "A String", # The domain of the display URL.
+    "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+    "headlines": [ # The list of headlines shown on the call-to-action banner.
+      "A String",
+    ],
+    "longHeadlines": [ # The list of lone headlines shown on the call-to-action banner.
+      "A String",
+    ],
+    "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+    "videos": [ # The list of YouTube video assets used by this ad.
+      { # Details of a YouTube video.
+        "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+        "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+      },
+    ],
+  },
+}
+
+ +
+ list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists ad group ads.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser the ads belong to. (required)
+  filter: string, Optional. Allows filtering by ad group ad fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `adGroupId` * `displayName` * `entityStatus` * `adGroupAdId` Examples: * All ad group ads under an ad group: `adGroupId="1234"` * All ad group ads under an ad group with an entityStatus of `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED`: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
+  orderBy: string, Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.
+  pageSize: integer, Optional. Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
+  pageToken: string, Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroupAds` method. If not specified, the first page of results 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:
+
+    {
+  "adGroupAds": [ # The list of ads. This list will be absent if empty.
+    { # A single ad associated with an ad group.
+      "adGroupAdId": "A String", # Output only. The unique ID of the ad. Assigned by the system.
+      "adGroupId": "A String", # Required. The unique ID of the ad group that the ad belongs to.
+      "adPolicy": { # A single ad policy associated with an ad group ad. # Output only. The policy approval status of the ad.
+        "adPolicyApprovalStatus": "A String", # The policy approval status of an ad, indicating the approval decision.
+        "adPolicyReviewStatus": "A String", # The policy review status of an ad, indicating where in the review process the ad is currently.
+        "adPolicyTopicEntry": [ # The entries for each policy topic identified as relating to the ad. Each entry includes the topic, restriction level, and guidance on how to fix policy issues.
+          { # An entry describing how an ad has been identified as relating to an ad policy.
+            "appealInfo": { # Information on how to appeal a policy decision. # Information on how to appeal the policy decision.
+              "appealFormLink": "A String", # Only available when appeal_type is `APPEAL_FORM`.
+              "appealType": "A String", # Whether the decision can be appealed through a self-service appeal or an appeal form.
+            },
+            "helpCenterLink": "A String", # Ad policy help center link for the policy topic.
+            "policyDecisionType": "A String", # The source of the policy decision.
+            "policyEnforcementMeans": "A String", # The policy enforcement means used in the policy review.
+            "policyLabel": "A String", # Localized label text for policy. Examples include "Trademarks in text", "Contains Alcohol", etc.
+            "policyTopic": "A String", # The policy topic. Examples include "TRADEMARKS", "ALCOHOL", etc.
+            "policyTopicConstraints": [ # The serving constraints relevant to the policy decision.
+              { # Details on ad serving constraints.
+                "certificateDomainMismatchCountryList": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where the resource's domain is not covered by the certificates associated with it.
+                  "countries": [ # Countries where the ad cannot serve.
+                    { # Represents a country restriction.
+                      "countryCriterionId": "A String", # The country criterion id.
+                      "countryLabel": "A String", # Localized name for the country. May be empty.
+                    },
+                  ],
+                },
+                "certificateMissingCountryList": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where a certificate is required for serving.
+                  "countries": [ # Countries where the ad cannot serve.
+                    { # Represents a country restriction.
+                      "countryCriterionId": "A String", # The country criterion id.
+                      "countryLabel": "A String", # Localized name for the country. May be empty.
+                    },
+                  ],
+                },
+                "countryConstraint": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where the ad cannot serve.
+                  "countries": [ # Countries where the ad cannot serve.
+                    { # Represents a country restriction.
+                      "countryCriterionId": "A String", # The country criterion id.
+                      "countryLabel": "A String", # Localized name for the country. May be empty.
+                    },
+                  ],
+                },
+                "globalCertificateDomainMismatch": { # Certificate is required to serve in any country and the existing certificate does not cover the ad's domain. # Certificate is required to serve in any country and the existing certificate does not cover the ad's domain.
+                },
+                "globalCertificateMissing": { # Certificate is required to serve in any country. # Certificate is required to serve in any country.
+                },
+                "requestCertificateFormLink": "A String", # Link to the form to request a certificate for the constraint.
+                "resellerConstraint": { # Policy topic was constrained due to disapproval of the website for reseller purposes. # Reseller constraint.
+                },
+              },
+            ],
+            "policyTopicDescription": "A String", # A short summary description of the policy topic.
+            "policyTopicEvidences": [ # The evidence used in the policy decision.
+              { # Evidence information used in the policy decision.
+                "counterfeit": { # Details on the counterfeit enforcement that caused a policy violation. # Counterfeit enforcement that caused a policy violation.
+                  "owners": [ # The content or product owners that made a complaint.
+                    "A String",
+                  ],
+                },
+                "destinationMismatch": { # Details on a mismatch between destination URL types. # A mismatch between the ad destination URLs.
+                  "uriTypes": [ # The set of URLs that do not match. The list can include single or multiple uri types. Example 1: [`DISPLAY_URL`, `FINAL_URL`] means ad display URL does not match with the ad final URL. Example 2: [`FINAL_URL`] means ad final URL did not match the crawled url, which is also considered as destination mismatch.
+                    "A String",
+                  ],
+                },
+                "destinationNotWorking": { # Details for on HTTP or DNS errors related to the ad destination. # Information on HTTP or DNS errors related to the ad destination.
+                  "device": "A String", # The device where visiting the URL resulted in the error.
+                  "dnsErrorType": "A String", # The type of DNS error.
+                  "expandedUri": "A String", # The full URL that didn't work.
+                  "httpErrorCode": "A String", # The HTTP error code.
+                  "lastCheckedTime": "A String", # The last time the error was seen when navigating to URL.
+                },
+                "destinationTextList": { # A list of destination text that violated the policy. # The text in the destination of the ad that is causing a policy violation.
+                  "destinationTexts": [ # Destination text that caused the policy finding.
+                    "A String",
+                  ],
+                },
+                "httpCode": 42, # HTTP code returned when the final URL was crawled.
+                "languageCode": "A String", # The language the ad was detected to be written in. This field uses IETF language tags, such as "en-US".
+                "legalRemoval": { # Legal related regulation enforcement, either from DMCA or local legal regulation. # Legal related regulation enforcement that caused a policy violation.
+                  "complaintType": "A String", # The type of complaint causing the legal removal.
+                  "countryRestrictions": [ # The countries restricted due to the legal removal.
+                    { # Represents a country restriction.
+                      "countryCriterionId": "A String", # The country criterion id.
+                      "countryLabel": "A String", # Localized name for the country. May be empty.
+                    },
+                  ],
+                  "dmca": { # DMCA complaint details. # Details on the DMCA regulation legal removal.
+                    "complainant": "A String", # The entity who made the legal complaint.
+                  },
+                  "localLegal": { # Local legal regulation details. # Details on the local legal regulation legal removal.
+                    "lawType": "A String", # Type of law for the legal notice.
+                  },
+                  "restrictedUris": [ # The urls restricted due to the legal removal.
+                    "A String",
+                  ],
+                },
+                "regionalRequirements": { # Trust & Safety (T&S) proactive enforcement for policies meant to address regional requirements. This is considered a Google-owned investigation instead of a regulation notice since it's proactive T&S enforcement. # T&S proactive enforcement that caused a policy violation.
+                  "regionalRequirementsEntries": [ # List of regional requirements.
+                    { # Policy level regional legal violation details.
+                      "countryRestrictions": [ # The countries restricted due to the legal policy.
+                        { # Represents a country restriction.
+                          "countryCriterionId": "A String", # The country criterion id.
+                          "countryLabel": "A String", # Localized name for the country. May be empty.
+                        },
+                      ],
+                      "legalPolicy": "A String", # The legal policy that is being violated.
+                    },
+                  ],
+                },
+                "textList": { # A list of fragments of text that violated the policy. # List of evidence found in the text of the ad.
+                  "texts": [ # The fragments of text from the resource that caused the policy finding.
+                    "A String",
+                  ],
+                },
+                "trademark": { # Trademark terms that caused a policy violation. # Trademark terms that caused a policy violation.
+                  "countryRestrictions": [ # Countries where the policy violation is relevant.
+                    { # Represents a country restriction.
+                      "countryCriterionId": "A String", # The country criterion id.
+                      "countryLabel": "A String", # Localized name for the country. May be empty.
+                    },
+                  ],
+                  "owner": "A String", # The trademark content owner.
+                  "term": "A String", # The trademark term.
+                },
+                "websiteList": { # A list of websites that violated the policy. # List of websites linked with the ad.
+                  "websites": [ # Websites that caused the policy finding.
+                    "A String",
+                  ],
+                },
+              },
+            ],
+            "policyTopicType": "A String", # How ad serving will be affected due to the relation to the ad policy topic.
+          },
+        ],
+      },
+      "adUrls": [ # Output only. List of URLs used by the ad.
+        { # Additional URLs related to the ad, including beacons.
+          "type": "A String", # The type of the Ad URL.
+          "url": "A String", # The URL string value.
+        },
+      ],
+      "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad belongs to.
+      "audioAd": { # Details for an audio ad. # Output only. Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives.
+        "displayUrl": "A String", # The webpage address that appears with the ad.
+        "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+        "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+        "video": { # Details of a YouTube video. # The YouTube video of the ad.
+          "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+          "unavailableReason": "A String", # The reason why the video data is not available.
+          "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+        },
+      },
+      "bumperAd": { # Details for a bumper ad. # Output only. Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach.
+        "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
+          "actionButtonLabel": "A String", # The text on the call-to-action button.
+          "actionHeadline": "A String", # The headline of the call-to-action banner.
+          "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
+            "assetId": "A String", # Required. The unique ID of the asset.
+            "fileSize": "A String", # Output only. File size of the image asset in bytes.
+            "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+              "heightPixels": 42, # The height in pixels.
+              "widthPixels": 42, # The width in pixels.
+            },
+            "mimeType": "A String", # Output only. MIME type of the image asset.
+          },
+          "displayUrl": "A String", # The webpage address that appears with the ad.
+          "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+          "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+          "video": { # Details of a YouTube video. # The YouTube video of the ad.
+            "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+            "unavailableReason": "A String", # The reason why the video data is not available.
+            "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+          },
+        },
+      },
+      "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd).
+        "businessName": "A String", # Required. The business name shown on the ad.
+        "cards": [ # Required. The list of cards shown on the ad.
+          { # Details for a Demand Gen carousel card.
+            "callToAction": "A String", # Required. The call-to-action button shown on the card. Must use 10 characters or less.
+            "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the card on a mobile device.
+            "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the card.
+            "headline": "A String", # Required. The headline of the card.
+            "marketingImage": { # Meta data of an image asset. # Optional. The marketing image shown on the card.
+              "assetId": "A String", # Required. The unique ID of the asset.
+              "fileSize": "A String", # Output only. File size of the image asset in bytes.
+              "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+                "heightPixels": 42, # The height in pixels.
+                "widthPixels": 42, # The width in pixels.
+              },
+              "mimeType": "A String", # Output only. MIME type of the image asset.
+            },
+            "portraitMarketingImage": { # Meta data of an image asset. # Optional. The portrait marketing image shown on the card.
+              "assetId": "A String", # Required. The unique ID of the asset.
+              "fileSize": "A String", # Output only. File size of the image asset in bytes.
+              "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+                "heightPixels": 42, # The height in pixels.
+                "widthPixels": 42, # The width in pixels.
+              },
+              "mimeType": "A String", # Output only. MIME type of the image asset.
+            },
+            "squareMarketingImage": { # Meta data of an image asset. # Optional. The square marketing image shown on the card.
+              "assetId": "A String", # Required. The unique ID of the asset.
+              "fileSize": "A String", # Output only. File size of the image asset in bytes.
+              "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+                "heightPixels": 42, # The height in pixels.
+                "widthPixels": 42, # The width in pixels.
+              },
+              "mimeType": "A String", # Output only. MIME type of the image asset.
+            },
+          },
+        ],
+        "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template.
+          "a_key": "A String",
+        },
+        "description": "A String", # Required. The description of the ad.
+        "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad.
+        "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs.
+        "headline": "A String", # Required. The headline of the ad.
+        "logo": { # Meta data of an image asset. # Required. The logo image used by this ad.
+          "assetId": "A String", # Required. The unique ID of the asset.
+          "fileSize": "A String", # Output only. File size of the image asset in bytes.
+          "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+            "heightPixels": 42, # The height in pixels.
+            "widthPixels": 42, # The width in pixels.
+          },
+          "mimeType": "A String", # Output only. MIME type of the image asset.
+        },
+        "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes.
+        "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually.
+      },
+      "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd).
+        "businessName": "A String", # Required. The business name shown on the ad.
+        "callToAction": "A String", # Required. The call-to-action button shown on the ad.
+        "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template.
+          "a_key": "A String",
+        },
+        "descriptions": [ # Required. The list of descriptions shown on the ad.
+          "A String",
+        ],
+        "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the ad on a mobile device.
+        "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad.
+        "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs.
+        "headlines": [ # Required. The list of headlines shown on the ad.
+          "A String",
+        ],
+        "logoImages": [ # The list of logo images shown on the ad.
+          { # Meta data of an image asset.
+            "assetId": "A String", # Required. The unique ID of the asset.
+            "fileSize": "A String", # Output only. File size of the image asset in bytes.
+            "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+              "heightPixels": 42, # The height in pixels.
+              "widthPixels": 42, # The width in pixels.
+            },
+            "mimeType": "A String", # Output only. MIME type of the image asset.
+          },
+        ],
+        "marketingImages": [ # The list of marketing images shown on the ad.
+          { # Meta data of an image asset.
+            "assetId": "A String", # Required. The unique ID of the asset.
+            "fileSize": "A String", # Output only. File size of the image asset in bytes.
+            "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+              "heightPixels": 42, # The height in pixels.
+              "widthPixels": 42, # The width in pixels.
+            },
+            "mimeType": "A String", # Output only. MIME type of the image asset.
+          },
+        ],
+        "portraitMarketingImages": [ # The list of portrait marketing images shown on the ad.
+          { # Meta data of an image asset.
+            "assetId": "A String", # Required. The unique ID of the asset.
+            "fileSize": "A String", # Output only. File size of the image asset in bytes.
+            "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+              "heightPixels": 42, # The height in pixels.
+              "widthPixels": 42, # The width in pixels.
+            },
+            "mimeType": "A String", # Output only. MIME type of the image asset.
+          },
+        ],
+        "squareMarketingImages": [ # The list of square marketing images shown on the ad.
+          { # Meta data of an image asset.
+            "assetId": "A String", # Required. The unique ID of the asset.
+            "fileSize": "A String", # Output only. File size of the image asset in bytes.
+            "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+              "heightPixels": 42, # The height in pixels.
+              "widthPixels": 42, # The width in pixels.
+            },
+            "mimeType": "A String", # Output only. MIME type of the image asset.
+          },
+        ],
+        "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes.
+        "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually.
+      },
+      "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd).
+        "businessName": "A String", # Required. The business name shown on the ad.
+        "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE`
+        "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template.
+          "a_key": "A String",
+        },
+        "description": "A String", # Required. The description of the ad.
+        "displayUrlBreadcrumb1": "A String", # Optional. The first piece after the domain in the display URL.
+        "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL.
+        "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad.
+        "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs.
+        "headline": "A String", # Required. The headline of the ad.
+        "logo": { # Meta data of an image asset. # Required. The logo image used by this ad.
+          "assetId": "A String", # Required. The unique ID of the asset.
+          "fileSize": "A String", # Output only. File size of the image asset in bytes.
+          "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+            "heightPixels": 42, # The height in pixels.
+            "widthPixels": 42, # The width in pixels.
+          },
+          "mimeType": "A String", # Output only. MIME type of the image asset.
+        },
+        "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes.
+        "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually.
+      },
+      "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd).
+        "businessName": "A String", # Required. The business name shown on the ad.
+        "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW`
+        "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad.
+          "assetId": "A String", # Required. The unique ID of the asset.
+          "fileSize": "A String", # Output only. File size of the image asset in bytes.
+          "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+            "heightPixels": 42, # The height in pixels.
+            "widthPixels": 42, # The width in pixels.
+          },
+          "mimeType": "A String", # Output only. MIME type of the image asset.
+        },
+        "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template.
+          "a_key": "A String",
+        },
+        "descriptions": [ # Required. The list of descriptions shown on the ad.
+          "A String",
+        ],
+        "displayUrlBreadcrumb1": "A String", # Optional. The first piece after the domain in the display URL.
+        "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL.
+        "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the ad on a mobile device.
+        "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad.
+        "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs.
+        "headlines": [ # Required. The list of headlines shown on the ad.
+          "A String",
+        ],
+        "logo": { # Meta data of an image asset. # Required. The logo image used by this ad.
+          "assetId": "A String", # Required. The unique ID of the asset.
+          "fileSize": "A String", # Output only. File size of the image asset in bytes.
+          "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+            "heightPixels": 42, # The height in pixels.
+            "widthPixels": 42, # The width in pixels.
+          },
+          "mimeType": "A String", # Output only. MIME type of the image asset.
+        },
+        "longHeadlines": [ # Required. The list of lone headlines shown on the ad.
+          "A String",
+        ],
+        "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes.
+        "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually.
+        "videos": [ # Required. The list of YouTube video assets used by this ad.
+          { # Details of a YouTube video.
+            "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+            "unavailableReason": "A String", # The reason why the video data is not available.
+            "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+          },
+        ],
+      },
+      "displayName": "A String", # Required. The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes.
+      "displayVideoSourceAd": { # The ad sourced from a DV360 creative. # Output only. Details of an ad sourced from a Display & Video 360 creative.
+        "creativeId": "A String", # The ID of the source creative.
+      },
+      "entityStatus": "A String", # Required. The entity status of the ad.
+      "inStreamAd": { # Details for an in-stream ad. # Output only. Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives.
+        "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
+          "actionButtonLabel": "A String", # The text on the call-to-action button.
+          "actionHeadline": "A String", # The headline of the call-to-action banner.
+          "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
+            "assetId": "A String", # Required. The unique ID of the asset.
+            "fileSize": "A String", # Output only. File size of the image asset in bytes.
+            "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+              "heightPixels": 42, # The height in pixels.
+              "widthPixels": 42, # The width in pixels.
+            },
+            "mimeType": "A String", # Output only. MIME type of the image asset.
+          },
+          "displayUrl": "A String", # The webpage address that appears with the ad.
+          "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+          "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+          "video": { # Details of a YouTube video. # The YouTube video of the ad.
+            "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+            "unavailableReason": "A String", # The reason why the video data is not available.
+            "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+          },
+        },
+        "customParameters": { # The custom parameters to pass custom values to tracking URL template.
+          "a_key": "A String",
+        },
+      },
+      "mastheadAd": { # Details for a Masthead Ad. # Output only. Details of an [ad served on the YouTube Home feed](//support.google.com/google-ads/answer/9709826).
+        "autoplayVideoDuration": "A String", # The duration of time the video will autoplay.
+        "autoplayVideoStartMillisecond": "A String", # The amount of time in milliseconds after which the video will start to play.
+        "callToActionButtonLabel": "A String", # The text on the call-to-action button.
+        "callToActionFinalUrl": "A String", # The destination URL for the call-to-action button.
+        "callToActionTrackingUrl": "A String", # The tracking URL for the call-to-action button.
+        "companionYoutubeVideos": [ # The videos that appear next to the Masthead Ad on desktop. Can be no more than two.
+          { # Details of a YouTube video.
+            "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+            "unavailableReason": "A String", # The reason why the video data is not available.
+            "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+          },
+        ],
+        "description": "A String", # The description of the ad.
+        "headline": "A String", # The headline of the ad.
+        "showChannelArt": True or False, # Whether to show a background or banner that appears at the top of a YouTube page.
+        "video": { # Details of a YouTube video. # The YouTube video used by the ad.
+          "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+          "unavailableReason": "A String", # The reason why the video data is not available.
+          "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+        },
+        "videoAspectRatio": "A String", # The aspect ratio of the autoplaying YouTube video on the Masthead.
+      },
+      "name": "A String", # Output only. The resource name of the ad.
+      "nonSkippableAd": { # Details for a non-skippable ad. # Output only. Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives.
+        "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
+          "actionButtonLabel": "A String", # The text on the call-to-action button.
+          "actionHeadline": "A String", # The headline of the call-to-action banner.
+          "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
+            "assetId": "A String", # Required. The unique ID of the asset.
+            "fileSize": "A String", # Output only. File size of the image asset in bytes.
+            "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+              "heightPixels": 42, # The height in pixels.
+              "widthPixels": 42, # The width in pixels.
+            },
+            "mimeType": "A String", # Output only. MIME type of the image asset.
+          },
+          "displayUrl": "A String", # The webpage address that appears with the ad.
+          "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+          "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+          "video": { # Details of a YouTube video. # The YouTube video of the ad.
+            "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+            "unavailableReason": "A String", # The reason why the video data is not available.
+            "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+          },
+        },
+        "customParameters": { # The custom parameters to pass custom values to tracking URL template.
+          "a_key": "A String",
+        },
+      },
+      "videoDiscoverAd": { # Details for a video discovery ad. # Output only. Details of an [ad promoting a video](//support.google.com/displayvideo/answer/6274216) that shows in places of discovery.
+        "description1": "A String", # First text line for the ad.
+        "description2": "A String", # Second text line for the ad.
+        "headline": "A String", # The headline of ad.
+        "thumbnail": "A String", # Thumbnail image used in the ad.
+        "video": { # Details of a YouTube video. # The YouTube video the ad promotes.
+          "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+          "unavailableReason": "A String", # The reason why the video data is not available.
+          "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+        },
+      },
+      "videoPerformanceAd": { # Details for a video performance ad. # Output only. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product.
+        "actionButtonLabels": [ # The list of text assets shown on the call-to-action button.
+          "A String",
+        ],
+        "companionBanners": [ # The list of companion banners used by this ad.
+          { # Meta data of an image asset.
+            "assetId": "A String", # Required. The unique ID of the asset.
+            "fileSize": "A String", # Output only. File size of the image asset in bytes.
+            "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+              "heightPixels": 42, # The height in pixels.
+              "widthPixels": 42, # The width in pixels.
+            },
+            "mimeType": "A String", # Output only. MIME type of the image asset.
+          },
+        ],
+        "customParameters": { # The custom parameters to pass custom values to tracking URL template.
+          "a_key": "A String",
+        },
+        "descriptions": [ # The list of descriptions shown on the call-to-action banner.
+          "A String",
+        ],
+        "displayUrlBreadcrumb1": "A String", # The first piece after the domain in the display URL.
+        "displayUrlBreadcrumb2": "A String", # The second piece after the domain in the display URL.
+        "domain": "A String", # The domain of the display URL.
+        "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+        "headlines": [ # The list of headlines shown on the call-to-action banner.
+          "A String",
+        ],
+        "longHeadlines": [ # The list of lone headlines shown on the call-to-action banner.
+          "A String",
+        ],
+        "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+        "videos": [ # The list of YouTube video assets used by this ad.
+          { # Details of a YouTube video.
+            "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+            "unavailableReason": "A String", # The reason why the video data is not available.
+            "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+          },
+        ],
+      },
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAdGroupAds` method to retrieve the next page of 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(advertiserId, adGroupAdId, body=None, updateMask=None, x__xgafv=None) +
Updates an ad group ad.
+
+Args:
+  advertiserId: string, Output only. The unique ID of the advertiser the ad belongs to. (required)
+  adGroupAdId: string, Output only. The unique ID of the ad. Assigned by the system. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single ad associated with an ad group.
+  "adGroupAdId": "A String", # Output only. The unique ID of the ad. Assigned by the system.
+  "adGroupId": "A String", # Required. The unique ID of the ad group that the ad belongs to.
+  "adPolicy": { # A single ad policy associated with an ad group ad. # Output only. The policy approval status of the ad.
+    "adPolicyApprovalStatus": "A String", # The policy approval status of an ad, indicating the approval decision.
+    "adPolicyReviewStatus": "A String", # The policy review status of an ad, indicating where in the review process the ad is currently.
+    "adPolicyTopicEntry": [ # The entries for each policy topic identified as relating to the ad. Each entry includes the topic, restriction level, and guidance on how to fix policy issues.
+      { # An entry describing how an ad has been identified as relating to an ad policy.
+        "appealInfo": { # Information on how to appeal a policy decision. # Information on how to appeal the policy decision.
+          "appealFormLink": "A String", # Only available when appeal_type is `APPEAL_FORM`.
+          "appealType": "A String", # Whether the decision can be appealed through a self-service appeal or an appeal form.
+        },
+        "helpCenterLink": "A String", # Ad policy help center link for the policy topic.
+        "policyDecisionType": "A String", # The source of the policy decision.
+        "policyEnforcementMeans": "A String", # The policy enforcement means used in the policy review.
+        "policyLabel": "A String", # Localized label text for policy. Examples include "Trademarks in text", "Contains Alcohol", etc.
+        "policyTopic": "A String", # The policy topic. Examples include "TRADEMARKS", "ALCOHOL", etc.
+        "policyTopicConstraints": [ # The serving constraints relevant to the policy decision.
+          { # Details on ad serving constraints.
+            "certificateDomainMismatchCountryList": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where the resource's domain is not covered by the certificates associated with it.
+              "countries": [ # Countries where the ad cannot serve.
+                { # Represents a country restriction.
+                  "countryCriterionId": "A String", # The country criterion id.
+                  "countryLabel": "A String", # Localized name for the country. May be empty.
+                },
+              ],
+            },
+            "certificateMissingCountryList": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where a certificate is required for serving.
+              "countries": [ # Countries where the ad cannot serve.
+                { # Represents a country restriction.
+                  "countryCriterionId": "A String", # The country criterion id.
+                  "countryLabel": "A String", # Localized name for the country. May be empty.
+                },
+              ],
+            },
+            "countryConstraint": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where the ad cannot serve.
+              "countries": [ # Countries where the ad cannot serve.
+                { # Represents a country restriction.
+                  "countryCriterionId": "A String", # The country criterion id.
+                  "countryLabel": "A String", # Localized name for the country. May be empty.
+                },
+              ],
+            },
+            "globalCertificateDomainMismatch": { # Certificate is required to serve in any country and the existing certificate does not cover the ad's domain. # Certificate is required to serve in any country and the existing certificate does not cover the ad's domain.
+            },
+            "globalCertificateMissing": { # Certificate is required to serve in any country. # Certificate is required to serve in any country.
+            },
+            "requestCertificateFormLink": "A String", # Link to the form to request a certificate for the constraint.
+            "resellerConstraint": { # Policy topic was constrained due to disapproval of the website for reseller purposes. # Reseller constraint.
+            },
+          },
+        ],
+        "policyTopicDescription": "A String", # A short summary description of the policy topic.
+        "policyTopicEvidences": [ # The evidence used in the policy decision.
+          { # Evidence information used in the policy decision.
+            "counterfeit": { # Details on the counterfeit enforcement that caused a policy violation. # Counterfeit enforcement that caused a policy violation.
+              "owners": [ # The content or product owners that made a complaint.
+                "A String",
+              ],
+            },
+            "destinationMismatch": { # Details on a mismatch between destination URL types. # A mismatch between the ad destination URLs.
+              "uriTypes": [ # The set of URLs that do not match. The list can include single or multiple uri types. Example 1: [`DISPLAY_URL`, `FINAL_URL`] means ad display URL does not match with the ad final URL. Example 2: [`FINAL_URL`] means ad final URL did not match the crawled url, which is also considered as destination mismatch.
+                "A String",
+              ],
+            },
+            "destinationNotWorking": { # Details for on HTTP or DNS errors related to the ad destination. # Information on HTTP or DNS errors related to the ad destination.
+              "device": "A String", # The device where visiting the URL resulted in the error.
+              "dnsErrorType": "A String", # The type of DNS error.
+              "expandedUri": "A String", # The full URL that didn't work.
+              "httpErrorCode": "A String", # The HTTP error code.
+              "lastCheckedTime": "A String", # The last time the error was seen when navigating to URL.
+            },
+            "destinationTextList": { # A list of destination text that violated the policy. # The text in the destination of the ad that is causing a policy violation.
+              "destinationTexts": [ # Destination text that caused the policy finding.
+                "A String",
+              ],
+            },
+            "httpCode": 42, # HTTP code returned when the final URL was crawled.
+            "languageCode": "A String", # The language the ad was detected to be written in. This field uses IETF language tags, such as "en-US".
+            "legalRemoval": { # Legal related regulation enforcement, either from DMCA or local legal regulation. # Legal related regulation enforcement that caused a policy violation.
+              "complaintType": "A String", # The type of complaint causing the legal removal.
+              "countryRestrictions": [ # The countries restricted due to the legal removal.
+                { # Represents a country restriction.
+                  "countryCriterionId": "A String", # The country criterion id.
+                  "countryLabel": "A String", # Localized name for the country. May be empty.
+                },
+              ],
+              "dmca": { # DMCA complaint details. # Details on the DMCA regulation legal removal.
+                "complainant": "A String", # The entity who made the legal complaint.
+              },
+              "localLegal": { # Local legal regulation details. # Details on the local legal regulation legal removal.
+                "lawType": "A String", # Type of law for the legal notice.
+              },
+              "restrictedUris": [ # The urls restricted due to the legal removal.
+                "A String",
+              ],
+            },
+            "regionalRequirements": { # Trust & Safety (T&S) proactive enforcement for policies meant to address regional requirements. This is considered a Google-owned investigation instead of a regulation notice since it's proactive T&S enforcement. # T&S proactive enforcement that caused a policy violation.
+              "regionalRequirementsEntries": [ # List of regional requirements.
+                { # Policy level regional legal violation details.
+                  "countryRestrictions": [ # The countries restricted due to the legal policy.
+                    { # Represents a country restriction.
+                      "countryCriterionId": "A String", # The country criterion id.
+                      "countryLabel": "A String", # Localized name for the country. May be empty.
+                    },
+                  ],
+                  "legalPolicy": "A String", # The legal policy that is being violated.
+                },
+              ],
+            },
+            "textList": { # A list of fragments of text that violated the policy. # List of evidence found in the text of the ad.
+              "texts": [ # The fragments of text from the resource that caused the policy finding.
+                "A String",
+              ],
+            },
+            "trademark": { # Trademark terms that caused a policy violation. # Trademark terms that caused a policy violation.
+              "countryRestrictions": [ # Countries where the policy violation is relevant.
+                { # Represents a country restriction.
+                  "countryCriterionId": "A String", # The country criterion id.
+                  "countryLabel": "A String", # Localized name for the country. May be empty.
+                },
+              ],
+              "owner": "A String", # The trademark content owner.
+              "term": "A String", # The trademark term.
+            },
+            "websiteList": { # A list of websites that violated the policy. # List of websites linked with the ad.
+              "websites": [ # Websites that caused the policy finding.
+                "A String",
+              ],
+            },
+          },
+        ],
+        "policyTopicType": "A String", # How ad serving will be affected due to the relation to the ad policy topic.
+      },
+    ],
+  },
+  "adUrls": [ # Output only. List of URLs used by the ad.
+    { # Additional URLs related to the ad, including beacons.
+      "type": "A String", # The type of the Ad URL.
+      "url": "A String", # The URL string value.
+    },
+  ],
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad belongs to.
+  "audioAd": { # Details for an audio ad. # Output only. Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives.
+    "displayUrl": "A String", # The webpage address that appears with the ad.
+    "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+    "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+    "video": { # Details of a YouTube video. # The YouTube video of the ad.
+      "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+      "unavailableReason": "A String", # The reason why the video data is not available.
+      "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+    },
+  },
+  "bumperAd": { # Details for a bumper ad. # Output only. Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach.
+    "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
+      "actionButtonLabel": "A String", # The text on the call-to-action button.
+      "actionHeadline": "A String", # The headline of the call-to-action banner.
+      "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+      "displayUrl": "A String", # The webpage address that appears with the ad.
+      "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+      "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+      "video": { # Details of a YouTube video. # The YouTube video of the ad.
+        "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+        "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+      },
+    },
+  },
+  "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd).
+    "businessName": "A String", # Required. The business name shown on the ad.
+    "cards": [ # Required. The list of cards shown on the ad.
+      { # Details for a Demand Gen carousel card.
+        "callToAction": "A String", # Required. The call-to-action button shown on the card. Must use 10 characters or less.
+        "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the card on a mobile device.
+        "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the card.
+        "headline": "A String", # Required. The headline of the card.
+        "marketingImage": { # Meta data of an image asset. # Optional. The marketing image shown on the card.
+          "assetId": "A String", # Required. The unique ID of the asset.
+          "fileSize": "A String", # Output only. File size of the image asset in bytes.
+          "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+            "heightPixels": 42, # The height in pixels.
+            "widthPixels": 42, # The width in pixels.
+          },
+          "mimeType": "A String", # Output only. MIME type of the image asset.
+        },
+        "portraitMarketingImage": { # Meta data of an image asset. # Optional. The portrait marketing image shown on the card.
+          "assetId": "A String", # Required. The unique ID of the asset.
+          "fileSize": "A String", # Output only. File size of the image asset in bytes.
+          "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+            "heightPixels": 42, # The height in pixels.
+            "widthPixels": 42, # The width in pixels.
+          },
+          "mimeType": "A String", # Output only. MIME type of the image asset.
+        },
+        "squareMarketingImage": { # Meta data of an image asset. # Optional. The square marketing image shown on the card.
+          "assetId": "A String", # Required. The unique ID of the asset.
+          "fileSize": "A String", # Output only. File size of the image asset in bytes.
+          "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+            "heightPixels": 42, # The height in pixels.
+            "widthPixels": 42, # The width in pixels.
+          },
+          "mimeType": "A String", # Output only. MIME type of the image asset.
+        },
+      },
+    ],
+    "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+    "description": "A String", # Required. The description of the ad.
+    "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad.
+    "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs.
+    "headline": "A String", # Required. The headline of the ad.
+    "logo": { # Meta data of an image asset. # Required. The logo image used by this ad.
+      "assetId": "A String", # Required. The unique ID of the asset.
+      "fileSize": "A String", # Output only. File size of the image asset in bytes.
+      "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+        "heightPixels": 42, # The height in pixels.
+        "widthPixels": 42, # The width in pixels.
+      },
+      "mimeType": "A String", # Output only. MIME type of the image asset.
+    },
+    "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes.
+    "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually.
+  },
+  "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd).
+    "businessName": "A String", # Required. The business name shown on the ad.
+    "callToAction": "A String", # Required. The call-to-action button shown on the ad.
+    "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+    "descriptions": [ # Required. The list of descriptions shown on the ad.
+      "A String",
+    ],
+    "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the ad on a mobile device.
+    "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad.
+    "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs.
+    "headlines": [ # Required. The list of headlines shown on the ad.
+      "A String",
+    ],
+    "logoImages": [ # The list of logo images shown on the ad.
+      { # Meta data of an image asset.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+    ],
+    "marketingImages": [ # The list of marketing images shown on the ad.
+      { # Meta data of an image asset.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+    ],
+    "portraitMarketingImages": [ # The list of portrait marketing images shown on the ad.
+      { # Meta data of an image asset.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+    ],
+    "squareMarketingImages": [ # The list of square marketing images shown on the ad.
+      { # Meta data of an image asset.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+    ],
+    "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes.
+    "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually.
+  },
+  "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd).
+    "businessName": "A String", # Required. The business name shown on the ad.
+    "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE`
+    "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+    "description": "A String", # Required. The description of the ad.
+    "displayUrlBreadcrumb1": "A String", # Optional. The first piece after the domain in the display URL.
+    "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL.
+    "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad.
+    "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs.
+    "headline": "A String", # Required. The headline of the ad.
+    "logo": { # Meta data of an image asset. # Required. The logo image used by this ad.
+      "assetId": "A String", # Required. The unique ID of the asset.
+      "fileSize": "A String", # Output only. File size of the image asset in bytes.
+      "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+        "heightPixels": 42, # The height in pixels.
+        "widthPixels": 42, # The width in pixels.
+      },
+      "mimeType": "A String", # Output only. MIME type of the image asset.
+    },
+    "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes.
+    "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually.
+  },
+  "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd).
+    "businessName": "A String", # Required. The business name shown on the ad.
+    "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW`
+    "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad.
+      "assetId": "A String", # Required. The unique ID of the asset.
+      "fileSize": "A String", # Output only. File size of the image asset in bytes.
+      "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+        "heightPixels": 42, # The height in pixels.
+        "widthPixels": 42, # The width in pixels.
+      },
+      "mimeType": "A String", # Output only. MIME type of the image asset.
+    },
+    "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+    "descriptions": [ # Required. The list of descriptions shown on the ad.
+      "A String",
+    ],
+    "displayUrlBreadcrumb1": "A String", # Optional. The first piece after the domain in the display URL.
+    "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL.
+    "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the ad on a mobile device.
+    "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad.
+    "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs.
+    "headlines": [ # Required. The list of headlines shown on the ad.
+      "A String",
+    ],
+    "logo": { # Meta data of an image asset. # Required. The logo image used by this ad.
+      "assetId": "A String", # Required. The unique ID of the asset.
+      "fileSize": "A String", # Output only. File size of the image asset in bytes.
+      "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+        "heightPixels": 42, # The height in pixels.
+        "widthPixels": 42, # The width in pixels.
+      },
+      "mimeType": "A String", # Output only. MIME type of the image asset.
+    },
+    "longHeadlines": [ # Required. The list of lone headlines shown on the ad.
+      "A String",
+    ],
+    "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes.
+    "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually.
+    "videos": [ # Required. The list of YouTube video assets used by this ad.
+      { # Details of a YouTube video.
+        "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+        "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+      },
+    ],
+  },
+  "displayName": "A String", # Required. The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes.
+  "displayVideoSourceAd": { # The ad sourced from a DV360 creative. # Output only. Details of an ad sourced from a Display & Video 360 creative.
+    "creativeId": "A String", # The ID of the source creative.
+  },
+  "entityStatus": "A String", # Required. The entity status of the ad.
+  "inStreamAd": { # Details for an in-stream ad. # Output only. Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives.
+    "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
+      "actionButtonLabel": "A String", # The text on the call-to-action button.
+      "actionHeadline": "A String", # The headline of the call-to-action banner.
+      "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+      "displayUrl": "A String", # The webpage address that appears with the ad.
+      "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+      "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+      "video": { # Details of a YouTube video. # The YouTube video of the ad.
+        "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+        "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+      },
+    },
+    "customParameters": { # The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+  },
+  "mastheadAd": { # Details for a Masthead Ad. # Output only. Details of an [ad served on the YouTube Home feed](//support.google.com/google-ads/answer/9709826).
+    "autoplayVideoDuration": "A String", # The duration of time the video will autoplay.
+    "autoplayVideoStartMillisecond": "A String", # The amount of time in milliseconds after which the video will start to play.
+    "callToActionButtonLabel": "A String", # The text on the call-to-action button.
+    "callToActionFinalUrl": "A String", # The destination URL for the call-to-action button.
+    "callToActionTrackingUrl": "A String", # The tracking URL for the call-to-action button.
+    "companionYoutubeVideos": [ # The videos that appear next to the Masthead Ad on desktop. Can be no more than two.
+      { # Details of a YouTube video.
+        "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+        "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+      },
+    ],
+    "description": "A String", # The description of the ad.
+    "headline": "A String", # The headline of the ad.
+    "showChannelArt": True or False, # Whether to show a background or banner that appears at the top of a YouTube page.
+    "video": { # Details of a YouTube video. # The YouTube video used by the ad.
+      "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+      "unavailableReason": "A String", # The reason why the video data is not available.
+      "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+    },
+    "videoAspectRatio": "A String", # The aspect ratio of the autoplaying YouTube video on the Masthead.
+  },
+  "name": "A String", # Output only. The resource name of the ad.
+  "nonSkippableAd": { # Details for a non-skippable ad. # Output only. Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives.
+    "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
+      "actionButtonLabel": "A String", # The text on the call-to-action button.
+      "actionHeadline": "A String", # The headline of the call-to-action banner.
+      "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+      "displayUrl": "A String", # The webpage address that appears with the ad.
+      "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+      "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+      "video": { # Details of a YouTube video. # The YouTube video of the ad.
+        "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+        "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+      },
+    },
+    "customParameters": { # The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+  },
+  "videoDiscoverAd": { # Details for a video discovery ad. # Output only. Details of an [ad promoting a video](//support.google.com/displayvideo/answer/6274216) that shows in places of discovery.
+    "description1": "A String", # First text line for the ad.
+    "description2": "A String", # Second text line for the ad.
+    "headline": "A String", # The headline of ad.
+    "thumbnail": "A String", # Thumbnail image used in the ad.
+    "video": { # Details of a YouTube video. # The YouTube video the ad promotes.
+      "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+      "unavailableReason": "A String", # The reason why the video data is not available.
+      "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+    },
+  },
+  "videoPerformanceAd": { # Details for a video performance ad. # Output only. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product.
+    "actionButtonLabels": [ # The list of text assets shown on the call-to-action button.
+      "A String",
+    ],
+    "companionBanners": [ # The list of companion banners used by this ad.
+      { # Meta data of an image asset.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+    ],
+    "customParameters": { # The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+    "descriptions": [ # The list of descriptions shown on the call-to-action banner.
+      "A String",
+    ],
+    "displayUrlBreadcrumb1": "A String", # The first piece after the domain in the display URL.
+    "displayUrlBreadcrumb2": "A String", # The second piece after the domain in the display URL.
+    "domain": "A String", # The domain of the display URL.
+    "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+    "headlines": [ # The list of headlines shown on the call-to-action banner.
+      "A String",
+    ],
+    "longHeadlines": [ # The list of lone headlines shown on the call-to-action banner.
+      "A String",
+    ],
+    "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+    "videos": [ # The list of YouTube video assets used by this ad.
+      { # Details of a YouTube video.
+        "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+        "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+      },
+    ],
+  },
+}
+
+  updateMask: string, Required. The mask to control which fields to update.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single ad associated with an ad group.
+  "adGroupAdId": "A String", # Output only. The unique ID of the ad. Assigned by the system.
+  "adGroupId": "A String", # Required. The unique ID of the ad group that the ad belongs to.
+  "adPolicy": { # A single ad policy associated with an ad group ad. # Output only. The policy approval status of the ad.
+    "adPolicyApprovalStatus": "A String", # The policy approval status of an ad, indicating the approval decision.
+    "adPolicyReviewStatus": "A String", # The policy review status of an ad, indicating where in the review process the ad is currently.
+    "adPolicyTopicEntry": [ # The entries for each policy topic identified as relating to the ad. Each entry includes the topic, restriction level, and guidance on how to fix policy issues.
+      { # An entry describing how an ad has been identified as relating to an ad policy.
+        "appealInfo": { # Information on how to appeal a policy decision. # Information on how to appeal the policy decision.
+          "appealFormLink": "A String", # Only available when appeal_type is `APPEAL_FORM`.
+          "appealType": "A String", # Whether the decision can be appealed through a self-service appeal or an appeal form.
+        },
+        "helpCenterLink": "A String", # Ad policy help center link for the policy topic.
+        "policyDecisionType": "A String", # The source of the policy decision.
+        "policyEnforcementMeans": "A String", # The policy enforcement means used in the policy review.
+        "policyLabel": "A String", # Localized label text for policy. Examples include "Trademarks in text", "Contains Alcohol", etc.
+        "policyTopic": "A String", # The policy topic. Examples include "TRADEMARKS", "ALCOHOL", etc.
+        "policyTopicConstraints": [ # The serving constraints relevant to the policy decision.
+          { # Details on ad serving constraints.
+            "certificateDomainMismatchCountryList": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where the resource's domain is not covered by the certificates associated with it.
+              "countries": [ # Countries where the ad cannot serve.
+                { # Represents a country restriction.
+                  "countryCriterionId": "A String", # The country criterion id.
+                  "countryLabel": "A String", # Localized name for the country. May be empty.
+                },
+              ],
+            },
+            "certificateMissingCountryList": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where a certificate is required for serving.
+              "countries": [ # Countries where the ad cannot serve.
+                { # Represents a country restriction.
+                  "countryCriterionId": "A String", # The country criterion id.
+                  "countryLabel": "A String", # Localized name for the country. May be empty.
+                },
+              ],
+            },
+            "countryConstraint": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where the ad cannot serve.
+              "countries": [ # Countries where the ad cannot serve.
+                { # Represents a country restriction.
+                  "countryCriterionId": "A String", # The country criterion id.
+                  "countryLabel": "A String", # Localized name for the country. May be empty.
+                },
+              ],
+            },
+            "globalCertificateDomainMismatch": { # Certificate is required to serve in any country and the existing certificate does not cover the ad's domain. # Certificate is required to serve in any country and the existing certificate does not cover the ad's domain.
+            },
+            "globalCertificateMissing": { # Certificate is required to serve in any country. # Certificate is required to serve in any country.
+            },
+            "requestCertificateFormLink": "A String", # Link to the form to request a certificate for the constraint.
+            "resellerConstraint": { # Policy topic was constrained due to disapproval of the website for reseller purposes. # Reseller constraint.
+            },
+          },
+        ],
+        "policyTopicDescription": "A String", # A short summary description of the policy topic.
+        "policyTopicEvidences": [ # The evidence used in the policy decision.
+          { # Evidence information used in the policy decision.
+            "counterfeit": { # Details on the counterfeit enforcement that caused a policy violation. # Counterfeit enforcement that caused a policy violation.
+              "owners": [ # The content or product owners that made a complaint.
+                "A String",
+              ],
+            },
+            "destinationMismatch": { # Details on a mismatch between destination URL types. # A mismatch between the ad destination URLs.
+              "uriTypes": [ # The set of URLs that do not match. The list can include single or multiple uri types. Example 1: [`DISPLAY_URL`, `FINAL_URL`] means ad display URL does not match with the ad final URL. Example 2: [`FINAL_URL`] means ad final URL did not match the crawled url, which is also considered as destination mismatch.
+                "A String",
+              ],
+            },
+            "destinationNotWorking": { # Details for on HTTP or DNS errors related to the ad destination. # Information on HTTP or DNS errors related to the ad destination.
+              "device": "A String", # The device where visiting the URL resulted in the error.
+              "dnsErrorType": "A String", # The type of DNS error.
+              "expandedUri": "A String", # The full URL that didn't work.
+              "httpErrorCode": "A String", # The HTTP error code.
+              "lastCheckedTime": "A String", # The last time the error was seen when navigating to URL.
+            },
+            "destinationTextList": { # A list of destination text that violated the policy. # The text in the destination of the ad that is causing a policy violation.
+              "destinationTexts": [ # Destination text that caused the policy finding.
+                "A String",
+              ],
+            },
+            "httpCode": 42, # HTTP code returned when the final URL was crawled.
+            "languageCode": "A String", # The language the ad was detected to be written in. This field uses IETF language tags, such as "en-US".
+            "legalRemoval": { # Legal related regulation enforcement, either from DMCA or local legal regulation. # Legal related regulation enforcement that caused a policy violation.
+              "complaintType": "A String", # The type of complaint causing the legal removal.
+              "countryRestrictions": [ # The countries restricted due to the legal removal.
+                { # Represents a country restriction.
+                  "countryCriterionId": "A String", # The country criterion id.
+                  "countryLabel": "A String", # Localized name for the country. May be empty.
+                },
+              ],
+              "dmca": { # DMCA complaint details. # Details on the DMCA regulation legal removal.
+                "complainant": "A String", # The entity who made the legal complaint.
+              },
+              "localLegal": { # Local legal regulation details. # Details on the local legal regulation legal removal.
+                "lawType": "A String", # Type of law for the legal notice.
+              },
+              "restrictedUris": [ # The urls restricted due to the legal removal.
+                "A String",
+              ],
+            },
+            "regionalRequirements": { # Trust & Safety (T&S) proactive enforcement for policies meant to address regional requirements. This is considered a Google-owned investigation instead of a regulation notice since it's proactive T&S enforcement. # T&S proactive enforcement that caused a policy violation.
+              "regionalRequirementsEntries": [ # List of regional requirements.
+                { # Policy level regional legal violation details.
+                  "countryRestrictions": [ # The countries restricted due to the legal policy.
+                    { # Represents a country restriction.
+                      "countryCriterionId": "A String", # The country criterion id.
+                      "countryLabel": "A String", # Localized name for the country. May be empty.
+                    },
+                  ],
+                  "legalPolicy": "A String", # The legal policy that is being violated.
+                },
+              ],
+            },
+            "textList": { # A list of fragments of text that violated the policy. # List of evidence found in the text of the ad.
+              "texts": [ # The fragments of text from the resource that caused the policy finding.
+                "A String",
+              ],
+            },
+            "trademark": { # Trademark terms that caused a policy violation. # Trademark terms that caused a policy violation.
+              "countryRestrictions": [ # Countries where the policy violation is relevant.
+                { # Represents a country restriction.
+                  "countryCriterionId": "A String", # The country criterion id.
+                  "countryLabel": "A String", # Localized name for the country. May be empty.
+                },
+              ],
+              "owner": "A String", # The trademark content owner.
+              "term": "A String", # The trademark term.
+            },
+            "websiteList": { # A list of websites that violated the policy. # List of websites linked with the ad.
+              "websites": [ # Websites that caused the policy finding.
+                "A String",
+              ],
+            },
+          },
+        ],
+        "policyTopicType": "A String", # How ad serving will be affected due to the relation to the ad policy topic.
+      },
+    ],
+  },
+  "adUrls": [ # Output only. List of URLs used by the ad.
+    { # Additional URLs related to the ad, including beacons.
+      "type": "A String", # The type of the Ad URL.
+      "url": "A String", # The URL string value.
+    },
+  ],
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad belongs to.
+  "audioAd": { # Details for an audio ad. # Output only. Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives.
+    "displayUrl": "A String", # The webpage address that appears with the ad.
+    "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+    "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+    "video": { # Details of a YouTube video. # The YouTube video of the ad.
+      "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+      "unavailableReason": "A String", # The reason why the video data is not available.
+      "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+    },
+  },
+  "bumperAd": { # Details for a bumper ad. # Output only. Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach.
+    "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
+      "actionButtonLabel": "A String", # The text on the call-to-action button.
+      "actionHeadline": "A String", # The headline of the call-to-action banner.
+      "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+      "displayUrl": "A String", # The webpage address that appears with the ad.
+      "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+      "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+      "video": { # Details of a YouTube video. # The YouTube video of the ad.
+        "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+        "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+      },
+    },
+  },
+  "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd).
+    "businessName": "A String", # Required. The business name shown on the ad.
+    "cards": [ # Required. The list of cards shown on the ad.
+      { # Details for a Demand Gen carousel card.
+        "callToAction": "A String", # Required. The call-to-action button shown on the card. Must use 10 characters or less.
+        "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the card on a mobile device.
+        "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the card.
+        "headline": "A String", # Required. The headline of the card.
+        "marketingImage": { # Meta data of an image asset. # Optional. The marketing image shown on the card.
+          "assetId": "A String", # Required. The unique ID of the asset.
+          "fileSize": "A String", # Output only. File size of the image asset in bytes.
+          "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+            "heightPixels": 42, # The height in pixels.
+            "widthPixels": 42, # The width in pixels.
+          },
+          "mimeType": "A String", # Output only. MIME type of the image asset.
+        },
+        "portraitMarketingImage": { # Meta data of an image asset. # Optional. The portrait marketing image shown on the card.
+          "assetId": "A String", # Required. The unique ID of the asset.
+          "fileSize": "A String", # Output only. File size of the image asset in bytes.
+          "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+            "heightPixels": 42, # The height in pixels.
+            "widthPixels": 42, # The width in pixels.
+          },
+          "mimeType": "A String", # Output only. MIME type of the image asset.
+        },
+        "squareMarketingImage": { # Meta data of an image asset. # Optional. The square marketing image shown on the card.
+          "assetId": "A String", # Required. The unique ID of the asset.
+          "fileSize": "A String", # Output only. File size of the image asset in bytes.
+          "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+            "heightPixels": 42, # The height in pixels.
+            "widthPixels": 42, # The width in pixels.
+          },
+          "mimeType": "A String", # Output only. MIME type of the image asset.
+        },
+      },
+    ],
+    "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+    "description": "A String", # Required. The description of the ad.
+    "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad.
+    "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs.
+    "headline": "A String", # Required. The headline of the ad.
+    "logo": { # Meta data of an image asset. # Required. The logo image used by this ad.
+      "assetId": "A String", # Required. The unique ID of the asset.
+      "fileSize": "A String", # Output only. File size of the image asset in bytes.
+      "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+        "heightPixels": 42, # The height in pixels.
+        "widthPixels": 42, # The width in pixels.
+      },
+      "mimeType": "A String", # Output only. MIME type of the image asset.
+    },
+    "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes.
+    "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually.
+  },
+  "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd).
+    "businessName": "A String", # Required. The business name shown on the ad.
+    "callToAction": "A String", # Required. The call-to-action button shown on the ad.
+    "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+    "descriptions": [ # Required. The list of descriptions shown on the ad.
+      "A String",
+    ],
+    "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the ad on a mobile device.
+    "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad.
+    "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs.
+    "headlines": [ # Required. The list of headlines shown on the ad.
+      "A String",
+    ],
+    "logoImages": [ # The list of logo images shown on the ad.
+      { # Meta data of an image asset.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+    ],
+    "marketingImages": [ # The list of marketing images shown on the ad.
+      { # Meta data of an image asset.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+    ],
+    "portraitMarketingImages": [ # The list of portrait marketing images shown on the ad.
+      { # Meta data of an image asset.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+    ],
+    "squareMarketingImages": [ # The list of square marketing images shown on the ad.
+      { # Meta data of an image asset.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+    ],
+    "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes.
+    "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually.
+  },
+  "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd).
+    "businessName": "A String", # Required. The business name shown on the ad.
+    "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE`
+    "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+    "description": "A String", # Required. The description of the ad.
+    "displayUrlBreadcrumb1": "A String", # Optional. The first piece after the domain in the display URL.
+    "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL.
+    "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad.
+    "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs.
+    "headline": "A String", # Required. The headline of the ad.
+    "logo": { # Meta data of an image asset. # Required. The logo image used by this ad.
+      "assetId": "A String", # Required. The unique ID of the asset.
+      "fileSize": "A String", # Output only. File size of the image asset in bytes.
+      "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+        "heightPixels": 42, # The height in pixels.
+        "widthPixels": 42, # The width in pixels.
+      },
+      "mimeType": "A String", # Output only. MIME type of the image asset.
+    },
+    "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes.
+    "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually.
+  },
+  "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd).
+    "businessName": "A String", # Required. The business name shown on the ad.
+    "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW`
+    "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad.
+      "assetId": "A String", # Required. The unique ID of the asset.
+      "fileSize": "A String", # Output only. File size of the image asset in bytes.
+      "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+        "heightPixels": 42, # The height in pixels.
+        "widthPixels": 42, # The width in pixels.
+      },
+      "mimeType": "A String", # Output only. MIME type of the image asset.
+    },
+    "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+    "descriptions": [ # Required. The list of descriptions shown on the ad.
+      "A String",
+    ],
+    "displayUrlBreadcrumb1": "A String", # Optional. The first piece after the domain in the display URL.
+    "displayUrlBreadcrumb2": "A String", # Optional. The second piece after the domain in the display URL.
+    "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the ad on a mobile device.
+    "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad.
+    "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs.
+    "headlines": [ # Required. The list of headlines shown on the ad.
+      "A String",
+    ],
+    "logo": { # Meta data of an image asset. # Required. The logo image used by this ad.
+      "assetId": "A String", # Required. The unique ID of the asset.
+      "fileSize": "A String", # Output only. File size of the image asset in bytes.
+      "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+        "heightPixels": 42, # The height in pixels.
+        "widthPixels": 42, # The width in pixels.
+      },
+      "mimeType": "A String", # Output only. MIME type of the image asset.
+    },
+    "longHeadlines": [ # Required. The list of lone headlines shown on the ad.
+      "A String",
+    ],
+    "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes.
+    "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually.
+    "videos": [ # Required. The list of YouTube video assets used by this ad.
+      { # Details of a YouTube video.
+        "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+        "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+      },
+    ],
+  },
+  "displayName": "A String", # Required. The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes.
+  "displayVideoSourceAd": { # The ad sourced from a DV360 creative. # Output only. Details of an ad sourced from a Display & Video 360 creative.
+    "creativeId": "A String", # The ID of the source creative.
+  },
+  "entityStatus": "A String", # Required. The entity status of the ad.
+  "inStreamAd": { # Details for an in-stream ad. # Output only. Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives.
+    "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
+      "actionButtonLabel": "A String", # The text on the call-to-action button.
+      "actionHeadline": "A String", # The headline of the call-to-action banner.
+      "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+      "displayUrl": "A String", # The webpage address that appears with the ad.
+      "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+      "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+      "video": { # Details of a YouTube video. # The YouTube video of the ad.
+        "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+        "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+      },
+    },
+    "customParameters": { # The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+  },
+  "mastheadAd": { # Details for a Masthead Ad. # Output only. Details of an [ad served on the YouTube Home feed](//support.google.com/google-ads/answer/9709826).
+    "autoplayVideoDuration": "A String", # The duration of time the video will autoplay.
+    "autoplayVideoStartMillisecond": "A String", # The amount of time in milliseconds after which the video will start to play.
+    "callToActionButtonLabel": "A String", # The text on the call-to-action button.
+    "callToActionFinalUrl": "A String", # The destination URL for the call-to-action button.
+    "callToActionTrackingUrl": "A String", # The tracking URL for the call-to-action button.
+    "companionYoutubeVideos": [ # The videos that appear next to the Masthead Ad on desktop. Can be no more than two.
+      { # Details of a YouTube video.
+        "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+        "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+      },
+    ],
+    "description": "A String", # The description of the ad.
+    "headline": "A String", # The headline of the ad.
+    "showChannelArt": True or False, # Whether to show a background or banner that appears at the top of a YouTube page.
+    "video": { # Details of a YouTube video. # The YouTube video used by the ad.
+      "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+      "unavailableReason": "A String", # The reason why the video data is not available.
+      "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+    },
+    "videoAspectRatio": "A String", # The aspect ratio of the autoplaying YouTube video on the Masthead.
+  },
+  "name": "A String", # Output only. The resource name of the ad.
+  "nonSkippableAd": { # Details for a non-skippable ad. # Output only. Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives.
+    "commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
+      "actionButtonLabel": "A String", # The text on the call-to-action button.
+      "actionHeadline": "A String", # The headline of the call-to-action banner.
+      "companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+      "displayUrl": "A String", # The webpage address that appears with the ad.
+      "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+      "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+      "video": { # Details of a YouTube video. # The YouTube video of the ad.
+        "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+        "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+      },
+    },
+    "customParameters": { # The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+  },
+  "videoDiscoverAd": { # Details for a video discovery ad. # Output only. Details of an [ad promoting a video](//support.google.com/displayvideo/answer/6274216) that shows in places of discovery.
+    "description1": "A String", # First text line for the ad.
+    "description2": "A String", # Second text line for the ad.
+    "headline": "A String", # The headline of ad.
+    "thumbnail": "A String", # Thumbnail image used in the ad.
+    "video": { # Details of a YouTube video. # The YouTube video the ad promotes.
+      "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+      "unavailableReason": "A String", # The reason why the video data is not available.
+      "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+    },
+  },
+  "videoPerformanceAd": { # Details for a video performance ad. # Output only. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product.
+    "actionButtonLabels": [ # The list of text assets shown on the call-to-action button.
+      "A String",
+    ],
+    "companionBanners": [ # The list of companion banners used by this ad.
+      { # Meta data of an image asset.
+        "assetId": "A String", # Required. The unique ID of the asset.
+        "fileSize": "A String", # Output only. File size of the image asset in bytes.
+        "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
+          "heightPixels": 42, # The height in pixels.
+          "widthPixels": 42, # The width in pixels.
+        },
+        "mimeType": "A String", # Output only. MIME type of the image asset.
+      },
+    ],
+    "customParameters": { # The custom parameters to pass custom values to tracking URL template.
+      "a_key": "A String",
+    },
+    "descriptions": [ # The list of descriptions shown on the call-to-action banner.
+      "A String",
+    ],
+    "displayUrlBreadcrumb1": "A String", # The first piece after the domain in the display URL.
+    "displayUrlBreadcrumb2": "A String", # The second piece after the domain in the display URL.
+    "domain": "A String", # The domain of the display URL.
+    "finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
+    "headlines": [ # The list of headlines shown on the call-to-action banner.
+      "A String",
+    ],
+    "longHeadlines": [ # The list of lone headlines shown on the call-to-action banner.
+      "A String",
+    ],
+    "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
+    "videos": [ # The list of YouTube video assets used by this ad.
+      { # Details of a YouTube video.
+        "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
+        "unavailableReason": "A String", # The reason why the video data is not available.
+        "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
+      },
+    ],
+  },
+}
\ No newline at end of file diff --git a/docs/dyn/displayvideo_v4.advertisers.adGroups.html b/docs/dyn/displayvideo_v4.advertisers.adGroups.html index b290e62081..b52da0d4c6 100644 --- a/docs/dyn/displayvideo_v4.advertisers.adGroups.html +++ b/docs/dyn/displayvideo_v4.advertisers.adGroups.html @@ -84,6 +84,9 @@

Instance Methods

Returns the youtubeAssetTypes Resource.

+

+ bulkEditAssignedTargetingOptions(advertiserId, body=None, x__xgafv=None)

+

Bulk edits targeting options for multiple ad groups. The same set of delete and create requests will be applied to all specified ad groups. Specifically, the operation will delete the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.delete_requests from each ad group, and then create the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.create_requests. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.

bulkListAssignedTargetingOptions(advertiserId, adGroupIds=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists assigned targeting options for multiple ad groups across targeting types. Inherited assigned targeting options are not included.

@@ -93,6 +96,12 @@

Instance Methods

close()

Close httplib2 connections.

+

+ create(advertiserId, body=None, x__xgafv=None)

+

Creates a new ad group. Returns the newly created ad group if successful.

+

+ delete(advertiserId, adGroupId, x__xgafv=None)

+

Deletes a AdGroup. Returns error code `NOT_FOUND` if the ad group does not exist.

get(advertiserId, adGroupId, x__xgafv=None)

Gets an ad group.

@@ -102,7 +111,397 @@

Instance Methods

list_next()

Retrieves the next page of results.

+

+ patch(advertiserId, adGroupId, body=None, updateMask=None, x__xgafv=None)

+

Updates an existing ad group. Returns the updated ad group if successful.

Method Details

+
+ bulkEditAssignedTargetingOptions(advertiserId, body=None, x__xgafv=None) +
Bulk edits targeting options for multiple ad groups. The same set of delete and create requests will be applied to all specified ad groups. Specifically, the operation will delete the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.delete_requests from each ad group, and then create the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.create_requests. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser the ad groups belong to. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for BulkEditAdGroupAssignedTargetingOptions.
+  "adGroupIds": [ # Required. The IDs of the ad groups the assigned targeting options will belong to. A maximum of 25 ad group IDs can be specified.
+    "A String",
+  ],
+  "createRequests": [ # Optional. The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionRequest`. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`
+    { # A request listing which assigned targeting options of a given targeting type should be created and added.
+      "assignedTargetingOptions": [ # Required. The assigned targeting options to create and add.
+        { # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.
+          "ageRangeDetails": { # Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`.
+            "ageRange": "A String", # Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
+          },
+          "appCategoryDetails": { # Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+            "displayName": "A String", # Output only. The display name of the app category.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+          },
+          "appDetails": { # Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. # App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`.
+            "appId": "A String", # Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.
+            "appPlatform": "A String", # Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID.
+            "displayName": "A String", # Output only. The display name of the app.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+          },
+          "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.
+          "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`
+          "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource.
+            "excludedFirstPartyAndPartnerAudienceGroup": { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other. # Optional. The first party and partner audience ids and recencies of the excluded first party and partner audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other.
+              "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+                { # Details of first party and partner audience targeting setting.
+                  "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+                  "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+                },
+              ],
+            },
+            "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other.
+              "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+                { # Details of Google audience targeting setting.
+                  "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+                },
+              ],
+            },
+            "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only.
+              "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.
+                { # Details of combined audience targeting setting.
+                  "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.
+                },
+              ],
+            },
+            "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only.
+              "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored.
+                { # Details of custom list targeting setting.
+                  "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id.
+                },
+              ],
+            },
+            "includedFirstPartyAndPartnerAudienceGroups": [ # Optional. The first party and partner audience ids and recencies of included first party and partner audience groups. Each first party and partner audience group contains first party and partner audience ids only. The relation between each first party and partner audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored.
+              { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other.
+                "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+                  { # Details of first party and partner audience targeting setting.
+                    "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+                    "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+                  },
+                ],
+              },
+            ],
+            "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only.
+              "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+                { # Details of Google audience targeting setting.
+                  "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+                },
+              ],
+            },
+          },
+          "audioContentTypeDetails": { # Details for audio content type assigned targeting option. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect. # Audio content type details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`.
+            "audioContentType": "A String", # Required. The audio content type.
+          },
+          "authorizedSellerStatusDetails": { # Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the "Authorized Direct Sellers and Resellers" option. # Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.
+            "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target.
+            "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
+          },
+          "browserDetails": { # Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`.
+            "displayName": "A String", # Output only. The display name of the browser.
+            "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field.
+            "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.
+          },
+          "businessChainDetails": { # Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain details. This field will be populated when the targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.
+            "displayName": "A String", # Output only. The display name of a business chain, e.g. "KFC", "Chase Bank".
+            "proximityRadiusAmount": 3.14, # Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6.
+            "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+            "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions.
+          },
+          "carrierAndIspDetails": { # Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.
+            "displayName": "A String", # Output only. The display name of the carrier or ISP.
+            "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field.
+            "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
+          },
+          "categoryDetails": { # Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence.
+            "displayName": "A String", # Output only. The display name of the category.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.
+          },
+          "channelDetails": { # Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. # Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`.
+            "channelId": "A String", # Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
+            "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.
+          },
+          "contentDurationDetails": { # Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect. # Content duration details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+            "contentDuration": "A String", # Output only. The content duration.
+            "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+          },
+          "contentGenreDetails": { # Details for content genre assigned targeting option. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. Explicitly targeting all options is not supported. Remove all content genre targeting options to achieve this effect. # Content genre details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+            "displayName": "A String", # Output only. The display name of the content genre.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+          },
+          "contentInstreamPositionDetails": { # Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
+            "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.
+            "contentInstreamPosition": "A String", # Required. The content instream position for video or audio ads.
+          },
+          "contentOutstreamPositionDetails": { # Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
+            "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+            "contentOutstreamPosition": "A String", # Required. The content outstream position.
+          },
+          "contentStreamTypeDetails": { # Details for content stream type assigned targeting option. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect. # Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+            "contentStreamType": "A String", # Output only. The content stream type.
+            "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+          },
+          "contentThemeExclusionDetails": { # Targeting details for content theme. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`. # Content theme details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`. Content theme are targeting exclusions. Advertiser level content theme exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content theme in addition to advertiser exclusions.
+            "contentTheme": "A String", # Output only. An enum for the DV360 content theme classifier.
+            "excludedContentTheme": "A String", # Required. An enum for the DV360 content theme classified to be EXCLUDED.
+            "excludedTargetingOptionId": "A String", # Required. ID of the content theme to be EXCLUDED.
+          },
+          "dayAndTimeDetails": { # Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. # Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`.
+            "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting.
+            "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).
+            "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).
+            "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER.
+          },
+          "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+            "displayName": "A String", # Output only. The display name of the device make and model.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+          },
+          "deviceTypeDetails": { # Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.
+            "deviceType": "A String", # Required. The display name of the device type.
+            "youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items.
+          },
+          "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded.
+            "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED.
+          },
+          "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`.
+            "environment": "A String", # Required. The serving environment.
+          },
+          "exchangeDetails": { # Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`.
+            "exchange": "A String", # Required. The enum value for the exchange.
+          },
+          "genderDetails": { # Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`.
+            "gender": "A String", # Required. The gender of the audience.
+          },
+          "geoRegionDetails": { # Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`.
+            "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
+            "geoRegionType": "A String", # Output only. The type of geographic region targeting.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
+          },
+          "householdIncomeDetails": { # Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
+            "householdIncome": "A String", # Required. The household income of the audience.
+          },
+          "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option.
+          "inventorySourceDetails": { # Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. # Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.
+            "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
+          },
+          "inventorySourceGroupDetails": { # Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
+            "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
+          },
+          "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned.
+            "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted.
+              "A String",
+            ],
+            "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+          },
+          "languageDetails": { # Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`.
+            "displayName": "A String", # Output only. The display name of the language (e.g., "French").
+            "negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field.
+            "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
+          },
+          "name": "A String", # Output only. The resource name for this assigned targeting option.
+          "nativeContentPositionDetails": { # Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect. # Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`.
+            "contentPosition": "A String", # Required. The content position.
+          },
+          "negativeKeywordListDetails": { # Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource.
+            "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
+          },
+          "omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details. This field will be populated when the targeting_type is `TARGETING_TYPE_OMID`.
+            "omid": "A String", # Required. The type of Open Measurement enabled inventory.
+          },
+          "onScreenPositionDetails": { # On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+            "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+            "onScreenPosition": "A String", # Output only. The on screen position.
+            "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+          },
+          "operatingSystemDetails": { # Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+            "displayName": "A String", # Output only. The display name of the operating system.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+          },
+          "parentalStatusDetails": { # Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.
+            "parentalStatus": "A String", # Required. The parental status of the audience.
+          },
+          "poiDetails": { # Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_POI`. # POI details. This field will be populated when the targeting_type is `TARGETING_TYPE_POI`.
+            "displayName": "A String", # Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available.
+            "latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
+            "longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
+            "proximityRadiusAmount": 3.14, # Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`.
+            "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+            "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_POI`. Accepted POI targeting option IDs can be retrieved using `targetingTypes.targetingOptions.search`. If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID "40741469;-74003387". **Upon** **creation, this field value will be updated to append a semicolon and** **alphanumerical hash value if only latitude/longitude coordinates are** **provided.**
+          },
+          "proximityLocationListDetails": { # Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
+            "proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
+            "proximityRadius": 3.14, # Required. Radius expressed in the distance units set in proximity_radius_unit. This represents the size of the area around a chosen location that will be targeted. Radius should be between 1 and 500 miles or 800 kilometers.
+            "proximityRadiusUnit": "A String", # Required. Radius distance units.
+          },
+          "regionalLocationListDetails": { # Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
+          },
+          "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them.
+            "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
+          },
+          "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`.
+            "sessionPosition": "A String", # The position where the ad will show in a session.
+          },
+          "subExchangeDetails": { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.
+            "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
+          },
+          "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option.
+          "thirdPartyVerifierDetails": { # Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
+            "adloox": { # Details of Scope3 (previously known as Adloox) brand safety settings. # Third party brand verifier -- Scope3 (previously known as Adloox).
+              "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads.
+              "excludedAdlooxCategories": [ # Scope3 categories to exclude.
+                "A String",
+              ],
+              "excludedFraudIvtMfaCategories": [ # Optional. Scope3's fraud IVT MFA categories to exclude.
+                "A String",
+              ],
+              "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+              "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads.
+            },
+            "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
+              "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
+                "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings.
+                "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings.
+              },
+              "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating.
+                "A String",
+              ],
+              "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls.
+                "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable.
+                "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories.
+                  "A String",
+                ],
+                "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories.
+                  "A String",
+                ],
+              },
+              "customSegmentId": "A String", # The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic
+              "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
+                "iab": "A String", # Target web and app inventory to maximize IAB viewable rate.
+                "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration.
+              },
+              "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates.
+                "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats.
+                "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT.
+              },
+              "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
+                "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size.
+                "videoIab": "A String", # Target web inventory to maximize IAB viewable rate.
+                "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate.
+              },
+            },
+            "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
+              "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive.
+                "A String",
+              ],
+              "displayViewability": "A String", # Display Viewability section (applicable to display line items only).
+              "excludeUnrateable": True or False, # Brand Safety - **Unrateable**.
+              "excludedAdFraudRisk": "A String", # Ad Fraud settings.
+              "excludedAdultRisk": "A String", # Brand Safety - **Adult content**.
+              "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**.
+              "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**.
+              "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**.
+              "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**.
+              "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**.
+              "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**.
+              "excludedViolenceRisk": "A String", # Brand Safety - **Violence**.
+              "qualitySyncCustomSegmentId": [ # Optional. The quality sync custom segment ID provided by Integral Ad Science. The ID must be between `3000000` and `4999999`, inclusive.
+                "A String",
+              ],
+              "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only).
+              "videoViewability": "A String", # Video Viewability Section (applicable to video line items only).
+            },
+          },
+          "urlDetails": { # Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. # URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "url": "A String", # Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`.
+          },
+          "userRewardedContentDetails": { # User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+            "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+            "userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
+          },
+          "videoPlayerSizeDetails": { # Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. # Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
+            "videoPlayerSize": "A String", # Required. The video player size.
+          },
+          "viewabilityDetails": { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource.
+            "viewability": "A String", # Required. The predicted viewability percentage.
+          },
+          "youtubeChannelDetails": { # Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. # YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.
+            "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+          },
+          "youtubeVideoDetails": { # Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. # YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.
+            "negative": True or False, # Indicates if this option is being negatively targeted.
+            "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
+          },
+        },
+      ],
+      "targetingType": "A String", # Required. Identifies the type of this assigned targeting option.
+    },
+  ],
+  "deleteRequests": [ # Optional. The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`
+    { # A request listing which assigned targeting options of a given targeting type should be deleted.
+      "assignedTargetingOptionIds": [ # Required. The assigned targeting option IDs to delete.
+        "A String",
+      ],
+      "targetingType": "A String", # Required. Identifies the type of this assigned targeting option.
+    },
+  ],
+}
+
+  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 BulkEditAssignedTargetingOptions.
+  "errors": [ # Output only. The error information for each ad group that failed to update.
+    { # 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).
+      "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.
+    },
+  ],
+  "failedAdGroupIds": [ # Output only. The IDs of the ad groups which failed to update.
+    "A String",
+  ],
+  "updatedAdGroupIds": [ # Output only. The IDs of the ad groups which were successfully updated.
+    "A String",
+  ],
+}
+
+
bulkListAssignedTargetingOptions(advertiserId, adGroupIds=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists assigned targeting options for multiple ad groups across targeting types. Inherited assigned targeting options are not included.
@@ -253,7 +652,7 @@ 

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -293,6 +692,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -476,6 +878,179 @@

Method Details

Close httplib2 connections.
+
+ create(advertiserId, body=None, x__xgafv=None) +
Creates a new ad group. Returns the newly created ad group if successful.
+
+Args:
+  advertiserId: string, Output only. The unique ID of the advertiser the ad group belongs to. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single ad group associated with a line item.
+  "adGroupFormat": "A String", # Required. The format of the ads in the ad group.
+  "adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system.
+  "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Specifies the inventory control of the ad group. This field is required for Demand Gen ad groups.
+    "adGroupInventoryStrategy": "A String", # The inventory strategy.
+    "selectedInventories": { # The inventory control of the ad group. # The selected inventories.
+      "allowDiscover": True or False, # Whether the ad group is opted-in to Discover inventory.
+      "allowGmail": True or False, # Whether the ad group is opted-in to Gmail inventory.
+      "allowGoogleDisplayNetwork": True or False, # Whether the ad group is opted-in to Google Display Network inventory.
+      "allowYoutubeFeed": True or False, # Whether the ad group is opted-in to YouTube in-feed inventory.
+      "allowYoutubeShorts": True or False, # Whether the ad group is opted-in to YouTube shorts inventory.
+      "allowYoutubeStream": True or False, # Whether the ad group is opted-in to YouTube in-stream.
+    },
+  },
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad group belongs to.
+  "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy used by the ad group. Only the youtubeAndPartnersBid and demandGenBid field can be used in the bidding strategy.
+    "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity.
+      "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field.
+      "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value.
+      "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level.
+      "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0.
+    },
+    "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
+      "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
+    },
+    "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
+      "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
+      "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
+      "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account.
+    },
+    "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity.
+      "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
+      "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value.
+      "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.
+    },
+    "youtubeAndPartnersBid": { # Settings that control the bid strategy for YouTube and Partners resources. # A bid strategy used by YouTube and Partners resources. It can only be used for a YouTube and Partners line item or ad group entity.
+      "adGroupEffectiveTargetCpaSource": "A String", # Output only. Source of the effective target CPA value for ad group.
+      "adGroupEffectiveTargetCpaValue": "A String", # Output only. The effective target CPA for ad group, in micros of advertiser's currency.
+      "type": "A String", # The type of the bidding strategy.
+      "value": "A String", # The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_SHARE_OF_VOICE` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0.
+    },
+  },
+  "displayName": "A String", # Required. The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.
+  "entityStatus": "A String", # Required. Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group's parent line item is not active, the ad group can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
+  "lineItemId": "A String", # Required. The unique ID of the line item that the ad group belongs to.
+  "name": "A String", # Output only. Identifier. The resource name of the ad group.
+  "productFeedData": { # The details of product feed. # Optional. The settings of the product feed in this ad group.
+    "isFeedDisabled": True or False, # Whether the product feed has opted-out of showing products.
+    "productMatchDimensions": [ # A list of dimensions used to match products.
+      { # A dimension used to match products.
+        "customLabel": { # The key and value of a custom label. # The custom label to match all the products with the label.
+          "key": "A String", # The key of the label.
+          "value": "A String", # The value of the label.
+        },
+        "productOfferId": "A String", # The ID of the product offer to match with a product with the same offer ID.
+      },
+    ],
+    "productMatchType": "A String", # How products are selected by the product feed.
+  },
+  "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # Optional. The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group.
+    "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.
+    "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.
+    "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single ad group associated with a line item.
+  "adGroupFormat": "A String", # Required. The format of the ads in the ad group.
+  "adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system.
+  "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Specifies the inventory control of the ad group. This field is required for Demand Gen ad groups.
+    "adGroupInventoryStrategy": "A String", # The inventory strategy.
+    "selectedInventories": { # The inventory control of the ad group. # The selected inventories.
+      "allowDiscover": True or False, # Whether the ad group is opted-in to Discover inventory.
+      "allowGmail": True or False, # Whether the ad group is opted-in to Gmail inventory.
+      "allowGoogleDisplayNetwork": True or False, # Whether the ad group is opted-in to Google Display Network inventory.
+      "allowYoutubeFeed": True or False, # Whether the ad group is opted-in to YouTube in-feed inventory.
+      "allowYoutubeShorts": True or False, # Whether the ad group is opted-in to YouTube shorts inventory.
+      "allowYoutubeStream": True or False, # Whether the ad group is opted-in to YouTube in-stream.
+    },
+  },
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad group belongs to.
+  "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy used by the ad group. Only the youtubeAndPartnersBid and demandGenBid field can be used in the bidding strategy.
+    "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity.
+      "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field.
+      "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value.
+      "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level.
+      "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0.
+    },
+    "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
+      "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
+    },
+    "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
+      "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
+      "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
+      "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account.
+    },
+    "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity.
+      "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
+      "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value.
+      "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.
+    },
+    "youtubeAndPartnersBid": { # Settings that control the bid strategy for YouTube and Partners resources. # A bid strategy used by YouTube and Partners resources. It can only be used for a YouTube and Partners line item or ad group entity.
+      "adGroupEffectiveTargetCpaSource": "A String", # Output only. Source of the effective target CPA value for ad group.
+      "adGroupEffectiveTargetCpaValue": "A String", # Output only. The effective target CPA for ad group, in micros of advertiser's currency.
+      "type": "A String", # The type of the bidding strategy.
+      "value": "A String", # The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_SHARE_OF_VOICE` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0.
+    },
+  },
+  "displayName": "A String", # Required. The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.
+  "entityStatus": "A String", # Required. Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group's parent line item is not active, the ad group can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
+  "lineItemId": "A String", # Required. The unique ID of the line item that the ad group belongs to.
+  "name": "A String", # Output only. Identifier. The resource name of the ad group.
+  "productFeedData": { # The details of product feed. # Optional. The settings of the product feed in this ad group.
+    "isFeedDisabled": True or False, # Whether the product feed has opted-out of showing products.
+    "productMatchDimensions": [ # A list of dimensions used to match products.
+      { # A dimension used to match products.
+        "customLabel": { # The key and value of a custom label. # The custom label to match all the products with the label.
+          "key": "A String", # The key of the label.
+          "value": "A String", # The value of the label.
+        },
+        "productOfferId": "A String", # The ID of the product offer to match with a product with the same offer ID.
+      },
+    ],
+    "productMatchType": "A String", # How products are selected by the product feed.
+  },
+  "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # Optional. The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group.
+    "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.
+    "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.
+    "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`.
+  },
+}
+
+ +
+ delete(advertiserId, adGroupId, x__xgafv=None) +
Deletes a AdGroup. Returns error code `NOT_FOUND` if the ad group does not exist.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser this ad group belongs to. (required)
+  adGroupId: string, Required. The ID of the ad group to delete. (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(advertiserId, adGroupId, x__xgafv=None)
Gets an ad group.
@@ -494,8 +1069,25 @@ 

Method Details

{ # A single ad group associated with a line item. "adGroupFormat": "A String", # Required. The format of the ads in the ad group. "adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system. + "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Specifies the inventory control of the ad group. This field is required for Demand Gen ad groups. + "adGroupInventoryStrategy": "A String", # The inventory strategy. + "selectedInventories": { # The inventory control of the ad group. # The selected inventories. + "allowDiscover": True or False, # Whether the ad group is opted-in to Discover inventory. + "allowGmail": True or False, # Whether the ad group is opted-in to Gmail inventory. + "allowGoogleDisplayNetwork": True or False, # Whether the ad group is opted-in to Google Display Network inventory. + "allowYoutubeFeed": True or False, # Whether the ad group is opted-in to YouTube in-feed inventory. + "allowYoutubeShorts": True or False, # Whether the ad group is opted-in to YouTube shorts inventory. + "allowYoutubeStream": True or False, # Whether the ad group is opted-in to YouTube in-stream. + }, + }, "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad group belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy used by the ad group. Only the youtubeAndPartnersBid and demandGenBid field can be used in the bidding strategy. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, @@ -566,8 +1158,25 @@

Method Details

{ # A single ad group associated with a line item. "adGroupFormat": "A String", # Required. The format of the ads in the ad group. "adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system. + "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Specifies the inventory control of the ad group. This field is required for Demand Gen ad groups. + "adGroupInventoryStrategy": "A String", # The inventory strategy. + "selectedInventories": { # The inventory control of the ad group. # The selected inventories. + "allowDiscover": True or False, # Whether the ad group is opted-in to Discover inventory. + "allowGmail": True or False, # Whether the ad group is opted-in to Gmail inventory. + "allowGoogleDisplayNetwork": True or False, # Whether the ad group is opted-in to Google Display Network inventory. + "allowYoutubeFeed": True or False, # Whether the ad group is opted-in to YouTube in-feed inventory. + "allowYoutubeShorts": True or False, # Whether the ad group is opted-in to YouTube shorts inventory. + "allowYoutubeStream": True or False, # Whether the ad group is opted-in to YouTube in-stream. + }, + }, "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad group belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy used by the ad group. Only the youtubeAndPartnersBid and demandGenBid field can be used in the bidding strategy. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, @@ -632,4 +1241,160 @@

Method Details

+
+ patch(advertiserId, adGroupId, body=None, updateMask=None, x__xgafv=None) +
Updates an existing ad group. Returns the updated ad group if successful.
+
+Args:
+  advertiserId: string, Output only. The unique ID of the advertiser the ad group belongs to. (required)
+  adGroupId: string, Output only. The unique ID of the ad group. Assigned by the system. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single ad group associated with a line item.
+  "adGroupFormat": "A String", # Required. The format of the ads in the ad group.
+  "adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system.
+  "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Specifies the inventory control of the ad group. This field is required for Demand Gen ad groups.
+    "adGroupInventoryStrategy": "A String", # The inventory strategy.
+    "selectedInventories": { # The inventory control of the ad group. # The selected inventories.
+      "allowDiscover": True or False, # Whether the ad group is opted-in to Discover inventory.
+      "allowGmail": True or False, # Whether the ad group is opted-in to Gmail inventory.
+      "allowGoogleDisplayNetwork": True or False, # Whether the ad group is opted-in to Google Display Network inventory.
+      "allowYoutubeFeed": True or False, # Whether the ad group is opted-in to YouTube in-feed inventory.
+      "allowYoutubeShorts": True or False, # Whether the ad group is opted-in to YouTube shorts inventory.
+      "allowYoutubeStream": True or False, # Whether the ad group is opted-in to YouTube in-stream.
+    },
+  },
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad group belongs to.
+  "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy used by the ad group. Only the youtubeAndPartnersBid and demandGenBid field can be used in the bidding strategy.
+    "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity.
+      "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field.
+      "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value.
+      "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level.
+      "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0.
+    },
+    "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
+      "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
+    },
+    "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
+      "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
+      "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
+      "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account.
+    },
+    "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity.
+      "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
+      "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value.
+      "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.
+    },
+    "youtubeAndPartnersBid": { # Settings that control the bid strategy for YouTube and Partners resources. # A bid strategy used by YouTube and Partners resources. It can only be used for a YouTube and Partners line item or ad group entity.
+      "adGroupEffectiveTargetCpaSource": "A String", # Output only. Source of the effective target CPA value for ad group.
+      "adGroupEffectiveTargetCpaValue": "A String", # Output only. The effective target CPA for ad group, in micros of advertiser's currency.
+      "type": "A String", # The type of the bidding strategy.
+      "value": "A String", # The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_SHARE_OF_VOICE` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0.
+    },
+  },
+  "displayName": "A String", # Required. The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.
+  "entityStatus": "A String", # Required. Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group's parent line item is not active, the ad group can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
+  "lineItemId": "A String", # Required. The unique ID of the line item that the ad group belongs to.
+  "name": "A String", # Output only. Identifier. The resource name of the ad group.
+  "productFeedData": { # The details of product feed. # Optional. The settings of the product feed in this ad group.
+    "isFeedDisabled": True or False, # Whether the product feed has opted-out of showing products.
+    "productMatchDimensions": [ # A list of dimensions used to match products.
+      { # A dimension used to match products.
+        "customLabel": { # The key and value of a custom label. # The custom label to match all the products with the label.
+          "key": "A String", # The key of the label.
+          "value": "A String", # The value of the label.
+        },
+        "productOfferId": "A String", # The ID of the product offer to match with a product with the same offer ID.
+      },
+    ],
+    "productMatchType": "A String", # How products are selected by the product feed.
+  },
+  "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # Optional. The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group.
+    "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.
+    "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.
+    "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`.
+  },
+}
+
+  updateMask: string, Required. The mask to control which fields to update.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single ad group associated with a line item.
+  "adGroupFormat": "A String", # Required. The format of the ads in the ad group.
+  "adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system.
+  "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Specifies the inventory control of the ad group. This field is required for Demand Gen ad groups.
+    "adGroupInventoryStrategy": "A String", # The inventory strategy.
+    "selectedInventories": { # The inventory control of the ad group. # The selected inventories.
+      "allowDiscover": True or False, # Whether the ad group is opted-in to Discover inventory.
+      "allowGmail": True or False, # Whether the ad group is opted-in to Gmail inventory.
+      "allowGoogleDisplayNetwork": True or False, # Whether the ad group is opted-in to Google Display Network inventory.
+      "allowYoutubeFeed": True or False, # Whether the ad group is opted-in to YouTube in-feed inventory.
+      "allowYoutubeShorts": True or False, # Whether the ad group is opted-in to YouTube shorts inventory.
+      "allowYoutubeStream": True or False, # Whether the ad group is opted-in to YouTube in-stream.
+    },
+  },
+  "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad group belongs to.
+  "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy used by the ad group. Only the youtubeAndPartnersBid and demandGenBid field can be used in the bidding strategy.
+    "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity.
+      "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field.
+      "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value.
+      "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level.
+      "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0.
+    },
+    "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
+      "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
+    },
+    "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
+      "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
+      "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
+      "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account.
+    },
+    "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity.
+      "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
+      "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency.
+      "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value.
+      "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.
+    },
+    "youtubeAndPartnersBid": { # Settings that control the bid strategy for YouTube and Partners resources. # A bid strategy used by YouTube and Partners resources. It can only be used for a YouTube and Partners line item or ad group entity.
+      "adGroupEffectiveTargetCpaSource": "A String", # Output only. Source of the effective target CPA value for ad group.
+      "adGroupEffectiveTargetCpaValue": "A String", # Output only. The effective target CPA for ad group, in micros of advertiser's currency.
+      "type": "A String", # The type of the bidding strategy.
+      "value": "A String", # The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_SHARE_OF_VOICE` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0.
+    },
+  },
+  "displayName": "A String", # Required. The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.
+  "entityStatus": "A String", # Required. Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group's parent line item is not active, the ad group can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
+  "lineItemId": "A String", # Required. The unique ID of the line item that the ad group belongs to.
+  "name": "A String", # Output only. Identifier. The resource name of the ad group.
+  "productFeedData": { # The details of product feed. # Optional. The settings of the product feed in this ad group.
+    "isFeedDisabled": True or False, # Whether the product feed has opted-out of showing products.
+    "productMatchDimensions": [ # A list of dimensions used to match products.
+      { # A dimension used to match products.
+        "customLabel": { # The key and value of a custom label. # The custom label to match all the products with the label.
+          "key": "A String", # The key of the label.
+          "value": "A String", # The value of the label.
+        },
+        "productOfferId": "A String", # The ID of the product offer to match with a product with the same offer ID.
+      },
+    ],
+    "productMatchType": "A String", # How products are selected by the product feed.
+  },
+  "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # Optional. The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group.
+    "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.
+    "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.
+    "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/displayvideo_v4.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v4.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html index 041616aee5..07fdeacafc 100644 --- a/docs/dyn/displayvideo_v4.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v4.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html @@ -77,6 +77,12 @@

Instance Methods

close()

Close httplib2 connections.

+

+ create(advertiserId, adGroupId, targetingType, body=None, x__xgafv=None)

+

Assigns a targeting option to an ad group. Returns the assigned targeting option if successful. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.

+

+ delete(advertiserId, adGroupId, targetingType, assignedTargetingOptionId, x__xgafv=None)

+

Deletes an assigned targeting option from an ad group. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.

get(advertiserId, adGroupId, targetingType, assignedTargetingOptionId, x__xgafv=None)

Gets a single targeting option assigned to an ad group. Inherited assigned targeting options are not included.

@@ -88,8 +94,809 @@

Instance Methods

Retrieves the next page of results.

Method Details

- close() -
Close httplib2 connections.
+ close() +
Close httplib2 connections.
+
+ +
+ create(advertiserId, adGroupId, targetingType, body=None, x__xgafv=None) +
Assigns a targeting option to an ad group. Returns the assigned targeting option if successful. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser the ad group belongs to. (required)
+  adGroupId: string, Required. The ID of the ad group the assigned targeting option will belong to. (required)
+  targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO` (required)
+    Allowed values
+      TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version.
+      TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps).
+      TARGETING_TYPE_APP_CATEGORY - Target an app category (for example, education or puzzle games).
+      TARGETING_TYPE_APP - Target a specific app (for example, Angry Birds).
+      TARGETING_TYPE_URL - Target a specific url (for example, quora.com).
+      TARGETING_TYPE_DAY_AND_TIME - Target ads during a chosen time period on a specific day.
+      TARGETING_TYPE_AGE_RANGE - Target ads to a specific age range (for example, 18-24).
+      TARGETING_TYPE_REGIONAL_LOCATION_LIST - Target ads to the specified regions on a regional location list.
+      TARGETING_TYPE_PROXIMITY_LOCATION_LIST - Target ads to the specified points of interest on a proximity location list.
+      TARGETING_TYPE_GENDER - Target ads to a specific gender (for example, female or male).
+      TARGETING_TYPE_VIDEO_PLAYER_SIZE - Target a specific video player size for video ads.
+      TARGETING_TYPE_USER_REWARDED_CONTENT - Target user rewarded content for video ads.
+      TARGETING_TYPE_PARENTAL_STATUS - Target ads to a specific parental status (for example, parent or not a parent).
+      TARGETING_TYPE_CONTENT_INSTREAM_POSITION - Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
+      TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION - Target ads in a specific content outstream position.
+      TARGETING_TYPE_DEVICE_TYPE - Target ads to a specific device type (for example, tablet or connected TV).
+      TARGETING_TYPE_AUDIENCE_GROUP - Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
+      TARGETING_TYPE_BROWSER - Target ads to specific web browsers (for example, Chrome).
+      TARGETING_TYPE_HOUSEHOLD_INCOME - Target ads to a specific household income range (for example, top 10%).
+      TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position.
+      TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify).
+      TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
+      TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult).
+      TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app).
+      TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
+      TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS).
+      TARGETING_TYPE_DEVICE_MAKE_MODEL - Target ads to a specific device make or model (for example, Roku or Samsung).
+      TARGETING_TYPE_KEYWORD - Target ads to a specific keyword (for example, dog or retriever).
+      TARGETING_TYPE_NEGATIVE_KEYWORD_LIST - Target ads to a specific negative keyword list.
+      TARGETING_TYPE_VIEWABILITY - Target ads to a specific viewability (for example, 80% viewable).
+      TARGETING_TYPE_CATEGORY - Target ads to a specific content category (for example, arts & entertainment).
+      TARGETING_TYPE_INVENTORY_SOURCE - Purchase impressions from specific deals and auction packages.
+      TARGETING_TYPE_LANGUAGE - Target ads to a specific language (for example, English or Japanese).
+      TARGETING_TYPE_AUTHORIZED_SELLER_STATUS - Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
+      TARGETING_TYPE_GEO_REGION - Target ads to a specific regional location (for example, a city or state).
+      TARGETING_TYPE_INVENTORY_SOURCE_GROUP - Purchase impressions from a group of deals and auction packages.
+      TARGETING_TYPE_EXCHANGE - Purchase impressions from specific exchanges.
+      TARGETING_TYPE_SUB_EXCHANGE - Purchase impressions from specific sub-exchanges.
+      TARGETING_TYPE_POI - Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
+      TARGETING_TYPE_BUSINESS_CHAIN - Target ads around locations of a business chain within a specific geo region.
+      TARGETING_TYPE_CONTENT_DURATION - Target ads to a specific video content duration.
+      TARGETING_TYPE_CONTENT_STREAM_TYPE - Target ads to a specific video content stream type.
+      TARGETING_TYPE_NATIVE_CONTENT_POSITION - Target ads to a specific native content position.
+      TARGETING_TYPE_OMID - Target ads in an Open Measurement enabled inventory.
+      TARGETING_TYPE_AUDIO_CONTENT_TYPE - Target ads to a specific audio content type.
+      TARGETING_TYPE_CONTENT_GENRE - Target ads to a specific content genre.
+      TARGETING_TYPE_YOUTUBE_VIDEO - Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_YOUTUBE_CHANNEL - Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_SESSION_POSITION - Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
+      TARGETING_TYPE_CONTENT_THEME_EXCLUSION - Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.
+  "ageRangeDetails": { # Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`.
+    "ageRange": "A String", # Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
+  },
+  "appCategoryDetails": { # Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+    "displayName": "A String", # Output only. The display name of the app category.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+  },
+  "appDetails": { # Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. # App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`.
+    "appId": "A String", # Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.
+    "appPlatform": "A String", # Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID.
+    "displayName": "A String", # Output only. The display name of the app.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.
+  "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`
+  "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource.
+    "excludedFirstPartyAndPartnerAudienceGroup": { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other. # Optional. The first party and partner audience ids and recencies of the excluded first party and partner audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other.
+      "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+        { # Details of first party and partner audience targeting setting.
+          "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+          "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+        },
+      ],
+    },
+    "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other.
+      "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+        { # Details of Google audience targeting setting.
+          "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+        },
+      ],
+    },
+    "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only.
+      "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.
+        { # Details of combined audience targeting setting.
+          "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.
+        },
+      ],
+    },
+    "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only.
+      "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored.
+        { # Details of custom list targeting setting.
+          "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id.
+        },
+      ],
+    },
+    "includedFirstPartyAndPartnerAudienceGroups": [ # Optional. The first party and partner audience ids and recencies of included first party and partner audience groups. Each first party and partner audience group contains first party and partner audience ids only. The relation between each first party and partner audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored.
+      { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other.
+        "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+          { # Details of first party and partner audience targeting setting.
+            "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+            "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+          },
+        ],
+      },
+    ],
+    "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only.
+      "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+        { # Details of Google audience targeting setting.
+          "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+        },
+      ],
+    },
+  },
+  "audioContentTypeDetails": { # Details for audio content type assigned targeting option. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect. # Audio content type details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`.
+    "audioContentType": "A String", # Required. The audio content type.
+  },
+  "authorizedSellerStatusDetails": { # Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the "Authorized Direct Sellers and Resellers" option. # Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.
+    "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
+  },
+  "browserDetails": { # Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`.
+    "displayName": "A String", # Output only. The display name of the browser.
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.
+  },
+  "businessChainDetails": { # Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain details. This field will be populated when the targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.
+    "displayName": "A String", # Output only. The display name of a business chain, e.g. "KFC", "Chase Bank".
+    "proximityRadiusAmount": 3.14, # Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6.
+    "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions.
+  },
+  "carrierAndIspDetails": { # Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.
+    "displayName": "A String", # Output only. The display name of the carrier or ISP.
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
+  },
+  "categoryDetails": { # Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence.
+    "displayName": "A String", # Output only. The display name of the category.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.
+  },
+  "channelDetails": { # Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. # Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`.
+    "channelId": "A String", # Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
+    "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.
+  },
+  "contentDurationDetails": { # Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect. # Content duration details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+    "contentDuration": "A String", # Output only. The content duration.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+  },
+  "contentGenreDetails": { # Details for content genre assigned targeting option. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. Explicitly targeting all options is not supported. Remove all content genre targeting options to achieve this effect. # Content genre details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+    "displayName": "A String", # Output only. The display name of the content genre.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+  },
+  "contentInstreamPositionDetails": { # Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.
+    "contentInstreamPosition": "A String", # Required. The content instream position for video or audio ads.
+  },
+  "contentOutstreamPositionDetails": { # Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+    "contentOutstreamPosition": "A String", # Required. The content outstream position.
+  },
+  "contentStreamTypeDetails": { # Details for content stream type assigned targeting option. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect. # Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+    "contentStreamType": "A String", # Output only. The content stream type.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+  },
+  "contentThemeExclusionDetails": { # Targeting details for content theme. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`. # Content theme details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`. Content theme are targeting exclusions. Advertiser level content theme exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content theme in addition to advertiser exclusions.
+    "contentTheme": "A String", # Output only. An enum for the DV360 content theme classifier.
+    "excludedContentTheme": "A String", # Required. An enum for the DV360 content theme classified to be EXCLUDED.
+    "excludedTargetingOptionId": "A String", # Required. ID of the content theme to be EXCLUDED.
+  },
+  "dayAndTimeDetails": { # Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. # Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`.
+    "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting.
+    "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).
+    "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).
+    "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER.
+  },
+  "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+    "displayName": "A String", # Output only. The display name of the device make and model.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+  },
+  "deviceTypeDetails": { # Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.
+    "deviceType": "A String", # Required. The display name of the device type.
+    "youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items.
+  },
+  "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded.
+    "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED.
+  },
+  "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`.
+    "environment": "A String", # Required. The serving environment.
+  },
+  "exchangeDetails": { # Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`.
+    "exchange": "A String", # Required. The enum value for the exchange.
+  },
+  "genderDetails": { # Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`.
+    "gender": "A String", # Required. The gender of the audience.
+  },
+  "geoRegionDetails": { # Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`.
+    "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
+    "geoRegionType": "A String", # Output only. The type of geographic region targeting.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
+  },
+  "householdIncomeDetails": { # Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
+    "householdIncome": "A String", # Required. The household income of the audience.
+  },
+  "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option.
+  "inventorySourceDetails": { # Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. # Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.
+    "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
+  },
+  "inventorySourceGroupDetails": { # Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
+    "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
+  },
+  "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned.
+    "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted.
+      "A String",
+    ],
+    "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "languageDetails": { # Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`.
+    "displayName": "A String", # Output only. The display name of the language (e.g., "French").
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
+  },
+  "name": "A String", # Output only. The resource name for this assigned targeting option.
+  "nativeContentPositionDetails": { # Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect. # Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`.
+    "contentPosition": "A String", # Required. The content position.
+  },
+  "negativeKeywordListDetails": { # Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource.
+    "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
+  },
+  "omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details. This field will be populated when the targeting_type is `TARGETING_TYPE_OMID`.
+    "omid": "A String", # Required. The type of Open Measurement enabled inventory.
+  },
+  "onScreenPositionDetails": { # On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+    "onScreenPosition": "A String", # Output only. The on screen position.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+  },
+  "operatingSystemDetails": { # Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+    "displayName": "A String", # Output only. The display name of the operating system.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+  },
+  "parentalStatusDetails": { # Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.
+    "parentalStatus": "A String", # Required. The parental status of the audience.
+  },
+  "poiDetails": { # Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_POI`. # POI details. This field will be populated when the targeting_type is `TARGETING_TYPE_POI`.
+    "displayName": "A String", # Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available.
+    "latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
+    "longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
+    "proximityRadiusAmount": 3.14, # Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`.
+    "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_POI`. Accepted POI targeting option IDs can be retrieved using `targetingTypes.targetingOptions.search`. If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID "40741469;-74003387". **Upon** **creation, this field value will be updated to append a semicolon and** **alphanumerical hash value if only latitude/longitude coordinates are** **provided.**
+  },
+  "proximityLocationListDetails": { # Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
+    "proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
+    "proximityRadius": 3.14, # Required. Radius expressed in the distance units set in proximity_radius_unit. This represents the size of the area around a chosen location that will be targeted. Radius should be between 1 and 500 miles or 800 kilometers.
+    "proximityRadiusUnit": "A String", # Required. Radius distance units.
+  },
+  "regionalLocationListDetails": { # Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
+  },
+  "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them.
+    "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
+  },
+  "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`.
+    "sessionPosition": "A String", # The position where the ad will show in a session.
+  },
+  "subExchangeDetails": { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
+  },
+  "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option.
+  "thirdPartyVerifierDetails": { # Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
+    "adloox": { # Details of Scope3 (previously known as Adloox) brand safety settings. # Third party brand verifier -- Scope3 (previously known as Adloox).
+      "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads.
+      "excludedAdlooxCategories": [ # Scope3 categories to exclude.
+        "A String",
+      ],
+      "excludedFraudIvtMfaCategories": [ # Optional. Scope3's fraud IVT MFA categories to exclude.
+        "A String",
+      ],
+      "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads.
+    },
+    "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
+      "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
+        "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings.
+        "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings.
+      },
+      "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating.
+        "A String",
+      ],
+      "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls.
+        "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable.
+        "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories.
+          "A String",
+        ],
+        "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories.
+          "A String",
+        ],
+      },
+      "customSegmentId": "A String", # The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic
+      "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
+        "iab": "A String", # Target web and app inventory to maximize IAB viewable rate.
+        "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration.
+      },
+      "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates.
+        "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats.
+        "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT.
+      },
+      "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
+        "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size.
+        "videoIab": "A String", # Target web inventory to maximize IAB viewable rate.
+        "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate.
+      },
+    },
+    "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
+      "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive.
+        "A String",
+      ],
+      "displayViewability": "A String", # Display Viewability section (applicable to display line items only).
+      "excludeUnrateable": True or False, # Brand Safety - **Unrateable**.
+      "excludedAdFraudRisk": "A String", # Ad Fraud settings.
+      "excludedAdultRisk": "A String", # Brand Safety - **Adult content**.
+      "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**.
+      "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**.
+      "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**.
+      "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**.
+      "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**.
+      "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**.
+      "excludedViolenceRisk": "A String", # Brand Safety - **Violence**.
+      "qualitySyncCustomSegmentId": [ # Optional. The quality sync custom segment ID provided by Integral Ad Science. The ID must be between `3000000` and `4999999`, inclusive.
+        "A String",
+      ],
+      "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only).
+      "videoViewability": "A String", # Video Viewability Section (applicable to video line items only).
+    },
+  },
+  "urlDetails": { # Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. # URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "url": "A String", # Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`.
+  },
+  "userRewardedContentDetails": { # User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+    "userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
+  },
+  "videoPlayerSizeDetails": { # Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. # Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
+    "videoPlayerSize": "A String", # Required. The video player size.
+  },
+  "viewabilityDetails": { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource.
+    "viewability": "A String", # Required. The predicted viewability percentage.
+  },
+  "youtubeChannelDetails": { # Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. # YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.
+    "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "youtubeVideoDetails": { # Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. # YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.
+  "ageRangeDetails": { # Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`.
+    "ageRange": "A String", # Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
+  },
+  "appCategoryDetails": { # Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+    "displayName": "A String", # Output only. The display name of the app category.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
+  },
+  "appDetails": { # Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. # App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`.
+    "appId": "A String", # Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.
+    "appPlatform": "A String", # Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID.
+    "displayName": "A String", # Output only. The display name of the app.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.
+  "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`
+  "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource.
+    "excludedFirstPartyAndPartnerAudienceGroup": { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other. # Optional. The first party and partner audience ids and recencies of the excluded first party and partner audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other.
+      "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+        { # Details of first party and partner audience targeting setting.
+          "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+          "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+        },
+      ],
+    },
+    "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other.
+      "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+        { # Details of Google audience targeting setting.
+          "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+        },
+      ],
+    },
+    "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only.
+      "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.
+        { # Details of combined audience targeting setting.
+          "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.
+        },
+      ],
+    },
+    "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only.
+      "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored.
+        { # Details of custom list targeting setting.
+          "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id.
+        },
+      ],
+    },
+    "includedFirstPartyAndPartnerAudienceGroups": [ # Optional. The first party and partner audience ids and recencies of included first party and partner audience groups. Each first party and partner audience group contains first party and partner audience ids only. The relation between each first party and partner audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored.
+      { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other.
+        "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
+          { # Details of first party and partner audience targeting setting.
+            "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
+            "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
+          },
+        ],
+      },
+    ],
+    "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only.
+      "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
+        { # Details of Google audience targeting setting.
+          "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
+        },
+      ],
+    },
+  },
+  "audioContentTypeDetails": { # Details for audio content type assigned targeting option. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect. # Audio content type details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`.
+    "audioContentType": "A String", # Required. The audio content type.
+  },
+  "authorizedSellerStatusDetails": { # Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the "Authorized Direct Sellers and Resellers" option. # Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.
+    "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
+  },
+  "browserDetails": { # Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`.
+    "displayName": "A String", # Output only. The display name of the browser.
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.
+  },
+  "businessChainDetails": { # Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain details. This field will be populated when the targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.
+    "displayName": "A String", # Output only. The display name of a business chain, e.g. "KFC", "Chase Bank".
+    "proximityRadiusAmount": 3.14, # Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6.
+    "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions.
+  },
+  "carrierAndIspDetails": { # Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.
+    "displayName": "A String", # Output only. The display name of the carrier or ISP.
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
+  },
+  "categoryDetails": { # Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence.
+    "displayName": "A String", # Output only. The display name of the category.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.
+  },
+  "channelDetails": { # Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. # Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`.
+    "channelId": "A String", # Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
+    "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.
+  },
+  "contentDurationDetails": { # Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect. # Content duration details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+    "contentDuration": "A String", # Output only. The content duration.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
+  },
+  "contentGenreDetails": { # Details for content genre assigned targeting option. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. Explicitly targeting all options is not supported. Remove all content genre targeting options to achieve this effect. # Content genre details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+    "displayName": "A String", # Output only. The display name of the content genre.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
+  },
+  "contentInstreamPositionDetails": { # Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.
+    "contentInstreamPosition": "A String", # Required. The content instream position for video or audio ads.
+  },
+  "contentOutstreamPositionDetails": { # Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+    "contentOutstreamPosition": "A String", # Required. The content outstream position.
+  },
+  "contentStreamTypeDetails": { # Details for content stream type assigned targeting option. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect. # Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+    "contentStreamType": "A String", # Output only. The content stream type.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
+  },
+  "contentThemeExclusionDetails": { # Targeting details for content theme. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`. # Content theme details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`. Content theme are targeting exclusions. Advertiser level content theme exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content theme in addition to advertiser exclusions.
+    "contentTheme": "A String", # Output only. An enum for the DV360 content theme classifier.
+    "excludedContentTheme": "A String", # Required. An enum for the DV360 content theme classified to be EXCLUDED.
+    "excludedTargetingOptionId": "A String", # Required. ID of the content theme to be EXCLUDED.
+  },
+  "dayAndTimeDetails": { # Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. # Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`.
+    "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting.
+    "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).
+    "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).
+    "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER.
+  },
+  "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+    "displayName": "A String", # Output only. The display name of the device make and model.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
+  },
+  "deviceTypeDetails": { # Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.
+    "deviceType": "A String", # Required. The display name of the device type.
+    "youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items.
+  },
+  "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded.
+    "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED.
+  },
+  "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`.
+    "environment": "A String", # Required. The serving environment.
+  },
+  "exchangeDetails": { # Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`.
+    "exchange": "A String", # Required. The enum value for the exchange.
+  },
+  "genderDetails": { # Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`.
+    "gender": "A String", # Required. The gender of the audience.
+  },
+  "geoRegionDetails": { # Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`.
+    "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
+    "geoRegionType": "A String", # Output only. The type of geographic region targeting.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
+  },
+  "householdIncomeDetails": { # Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
+    "householdIncome": "A String", # Required. The household income of the audience.
+  },
+  "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option.
+  "inventorySourceDetails": { # Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. # Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.
+    "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
+  },
+  "inventorySourceGroupDetails": { # Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
+    "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
+  },
+  "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned.
+    "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted.
+      "A String",
+    ],
+    "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "languageDetails": { # Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`.
+    "displayName": "A String", # Output only. The display name of the language (e.g., "French").
+    "negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
+  },
+  "name": "A String", # Output only. The resource name for this assigned targeting option.
+  "nativeContentPositionDetails": { # Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect. # Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`.
+    "contentPosition": "A String", # Required. The content position.
+  },
+  "negativeKeywordListDetails": { # Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource.
+    "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
+  },
+  "omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details. This field will be populated when the targeting_type is `TARGETING_TYPE_OMID`.
+    "omid": "A String", # Required. The type of Open Measurement enabled inventory.
+  },
+  "onScreenPositionDetails": { # On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+    "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+    "onScreenPosition": "A String", # Output only. The on screen position.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
+  },
+  "operatingSystemDetails": { # Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+    "displayName": "A String", # Output only. The display name of the operating system.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
+  },
+  "parentalStatusDetails": { # Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.
+    "parentalStatus": "A String", # Required. The parental status of the audience.
+  },
+  "poiDetails": { # Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_POI`. # POI details. This field will be populated when the targeting_type is `TARGETING_TYPE_POI`.
+    "displayName": "A String", # Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available.
+    "latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
+    "longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
+    "proximityRadiusAmount": 3.14, # Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`.
+    "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_POI`. Accepted POI targeting option IDs can be retrieved using `targetingTypes.targetingOptions.search`. If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID "40741469;-74003387". **Upon** **creation, this field value will be updated to append a semicolon and** **alphanumerical hash value if only latitude/longitude coordinates are** **provided.**
+  },
+  "proximityLocationListDetails": { # Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
+    "proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
+    "proximityRadius": 3.14, # Required. Radius expressed in the distance units set in proximity_radius_unit. This represents the size of the area around a chosen location that will be targeted. Radius should be between 1 and 500 miles or 800 kilometers.
+    "proximityRadiusUnit": "A String", # Required. Radius distance units.
+  },
+  "regionalLocationListDetails": { # Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
+  },
+  "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them.
+    "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
+  },
+  "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`.
+    "sessionPosition": "A String", # The position where the ad will show in a session.
+  },
+  "subExchangeDetails": { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.
+    "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
+  },
+  "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option.
+  "thirdPartyVerifierDetails": { # Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
+    "adloox": { # Details of Scope3 (previously known as Adloox) brand safety settings. # Third party brand verifier -- Scope3 (previously known as Adloox).
+      "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads.
+      "excludedAdlooxCategories": [ # Scope3 categories to exclude.
+        "A String",
+      ],
+      "excludedFraudIvtMfaCategories": [ # Optional. Scope3's fraud IVT MFA categories to exclude.
+        "A String",
+      ],
+      "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
+      "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads.
+    },
+    "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
+      "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
+        "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings.
+        "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings.
+      },
+      "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating.
+        "A String",
+      ],
+      "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls.
+        "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable.
+        "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories.
+          "A String",
+        ],
+        "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories.
+          "A String",
+        ],
+      },
+      "customSegmentId": "A String", # The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic
+      "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
+        "iab": "A String", # Target web and app inventory to maximize IAB viewable rate.
+        "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration.
+      },
+      "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates.
+        "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats.
+        "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT.
+      },
+      "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
+        "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size.
+        "videoIab": "A String", # Target web inventory to maximize IAB viewable rate.
+        "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate.
+      },
+    },
+    "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
+      "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive.
+        "A String",
+      ],
+      "displayViewability": "A String", # Display Viewability section (applicable to display line items only).
+      "excludeUnrateable": True or False, # Brand Safety - **Unrateable**.
+      "excludedAdFraudRisk": "A String", # Ad Fraud settings.
+      "excludedAdultRisk": "A String", # Brand Safety - **Adult content**.
+      "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**.
+      "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**.
+      "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**.
+      "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**.
+      "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**.
+      "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**.
+      "excludedViolenceRisk": "A String", # Brand Safety - **Violence**.
+      "qualitySyncCustomSegmentId": [ # Optional. The quality sync custom segment ID provided by Integral Ad Science. The ID must be between `3000000` and `4999999`, inclusive.
+        "A String",
+      ],
+      "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only).
+      "videoViewability": "A String", # Video Viewability Section (applicable to video line items only).
+    },
+  },
+  "urlDetails": { # Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. # URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "url": "A String", # Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`.
+  },
+  "userRewardedContentDetails": { # User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+    "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
+    "userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
+  },
+  "videoPlayerSizeDetails": { # Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. # Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
+    "videoPlayerSize": "A String", # Required. The video player size.
+  },
+  "viewabilityDetails": { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource.
+    "viewability": "A String", # Required. The predicted viewability percentage.
+  },
+  "youtubeChannelDetails": { # Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. # YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.
+    "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+  },
+  "youtubeVideoDetails": { # Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. # YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.
+    "negative": True or False, # Indicates if this option is being negatively targeted.
+    "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
+  },
+}
+
+ +
+ delete(advertiserId, adGroupId, targetingType, assignedTargetingOptionId, x__xgafv=None) +
Deletes an assigned targeting option from an ad group. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser the ad group belongs to. (required)
+  adGroupId: string, Required. The ID of the ad group the assigned targeting option belongs to. (required)
+  targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO` (required)
+    Allowed values
+      TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version.
+      TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps).
+      TARGETING_TYPE_APP_CATEGORY - Target an app category (for example, education or puzzle games).
+      TARGETING_TYPE_APP - Target a specific app (for example, Angry Birds).
+      TARGETING_TYPE_URL - Target a specific url (for example, quora.com).
+      TARGETING_TYPE_DAY_AND_TIME - Target ads during a chosen time period on a specific day.
+      TARGETING_TYPE_AGE_RANGE - Target ads to a specific age range (for example, 18-24).
+      TARGETING_TYPE_REGIONAL_LOCATION_LIST - Target ads to the specified regions on a regional location list.
+      TARGETING_TYPE_PROXIMITY_LOCATION_LIST - Target ads to the specified points of interest on a proximity location list.
+      TARGETING_TYPE_GENDER - Target ads to a specific gender (for example, female or male).
+      TARGETING_TYPE_VIDEO_PLAYER_SIZE - Target a specific video player size for video ads.
+      TARGETING_TYPE_USER_REWARDED_CONTENT - Target user rewarded content for video ads.
+      TARGETING_TYPE_PARENTAL_STATUS - Target ads to a specific parental status (for example, parent or not a parent).
+      TARGETING_TYPE_CONTENT_INSTREAM_POSITION - Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).
+      TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION - Target ads in a specific content outstream position.
+      TARGETING_TYPE_DEVICE_TYPE - Target ads to a specific device type (for example, tablet or connected TV).
+      TARGETING_TYPE_AUDIENCE_GROUP - Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.
+      TARGETING_TYPE_BROWSER - Target ads to specific web browsers (for example, Chrome).
+      TARGETING_TYPE_HOUSEHOLD_INCOME - Target ads to a specific household income range (for example, top 10%).
+      TARGETING_TYPE_ON_SCREEN_POSITION - Target ads in a specific on screen position.
+      TARGETING_TYPE_THIRD_PARTY_VERIFIER - Filter web sites through third party verification (for example, IAS or DoubleVerify).
+      TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION - Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).
+      TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION - Filter website content by sensitive categories (for example, adult).
+      TARGETING_TYPE_ENVIRONMENT - Target ads to a specific environment (for example, web or app).
+      TARGETING_TYPE_CARRIER_AND_ISP - Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).
+      TARGETING_TYPE_OPERATING_SYSTEM - Target ads to a specific operating system (for example, macOS).
+      TARGETING_TYPE_DEVICE_MAKE_MODEL - Target ads to a specific device make or model (for example, Roku or Samsung).
+      TARGETING_TYPE_KEYWORD - Target ads to a specific keyword (for example, dog or retriever).
+      TARGETING_TYPE_NEGATIVE_KEYWORD_LIST - Target ads to a specific negative keyword list.
+      TARGETING_TYPE_VIEWABILITY - Target ads to a specific viewability (for example, 80% viewable).
+      TARGETING_TYPE_CATEGORY - Target ads to a specific content category (for example, arts & entertainment).
+      TARGETING_TYPE_INVENTORY_SOURCE - Purchase impressions from specific deals and auction packages.
+      TARGETING_TYPE_LANGUAGE - Target ads to a specific language (for example, English or Japanese).
+      TARGETING_TYPE_AUTHORIZED_SELLER_STATUS - Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the "Authorized Direct Sellers and Resellers" option by default.
+      TARGETING_TYPE_GEO_REGION - Target ads to a specific regional location (for example, a city or state).
+      TARGETING_TYPE_INVENTORY_SOURCE_GROUP - Purchase impressions from a group of deals and auction packages.
+      TARGETING_TYPE_EXCHANGE - Purchase impressions from specific exchanges.
+      TARGETING_TYPE_SUB_EXCHANGE - Purchase impressions from specific sub-exchanges.
+      TARGETING_TYPE_POI - Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.
+      TARGETING_TYPE_BUSINESS_CHAIN - Target ads around locations of a business chain within a specific geo region.
+      TARGETING_TYPE_CONTENT_DURATION - Target ads to a specific video content duration.
+      TARGETING_TYPE_CONTENT_STREAM_TYPE - Target ads to a specific video content stream type.
+      TARGETING_TYPE_NATIVE_CONTENT_POSITION - Target ads to a specific native content position.
+      TARGETING_TYPE_OMID - Target ads in an Open Measurement enabled inventory.
+      TARGETING_TYPE_AUDIO_CONTENT_TYPE - Target ads to a specific audio content type.
+      TARGETING_TYPE_CONTENT_GENRE - Target ads to a specific content genre.
+      TARGETING_TYPE_YOUTUBE_VIDEO - Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_YOUTUBE_CHANNEL - Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.
+      TARGETING_TYPE_SESSION_POSITION - Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.
+      TARGETING_TYPE_CONTENT_THEME_EXCLUSION - Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources.
+  assignedTargetingOptionId: string, Required. The ID of the assigned targeting option to delete. (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); }
+}
@@ -287,7 +1094,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -327,6 +1134,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -687,7 +1497,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -727,6 +1537,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, diff --git a/docs/dyn/displayvideo_v4.advertisers.html b/docs/dyn/displayvideo_v4.advertisers.html index 2c991115df..7629236d79 100644 --- a/docs/dyn/displayvideo_v4.advertisers.html +++ b/docs/dyn/displayvideo_v4.advertisers.html @@ -498,7 +498,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -538,6 +538,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -847,7 +850,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -887,6 +890,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -1353,7 +1359,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1393,6 +1399,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, diff --git a/docs/dyn/displayvideo_v4.advertisers.insertionOrders.html b/docs/dyn/displayvideo_v4.advertisers.insertionOrders.html index 71c022e18e..b22c93d1de 100644 --- a/docs/dyn/displayvideo_v4.advertisers.insertionOrders.html +++ b/docs/dyn/displayvideo_v4.advertisers.insertionOrders.html @@ -113,6 +113,12 @@

Method Details

{ # A single insertion order. "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, @@ -213,6 +219,12 @@

Method Details

{ # A single insertion order. "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, @@ -340,6 +352,12 @@

Method Details

{ # A single insertion order. "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, @@ -453,6 +471,12 @@

Method Details

{ # A single insertion order. "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, @@ -573,6 +597,12 @@

Method Details

{ # A single insertion order. "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, @@ -674,6 +704,12 @@

Method Details

{ # A single insertion order. "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, diff --git a/docs/dyn/displayvideo_v4.advertisers.lineItems.html b/docs/dyn/displayvideo_v4.advertisers.lineItems.html index c288e6f6af..5ed54a8012 100644 --- a/docs/dyn/displayvideo_v4.advertisers.lineItems.html +++ b/docs/dyn/displayvideo_v4.advertisers.lineItems.html @@ -261,7 +261,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -301,6 +301,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -654,7 +657,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -694,6 +697,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -889,6 +895,12 @@

Method Details

"targetLineItem": { # A single line item. # Required. A line item object containing the fields to be updated and the new values to assign to all line items specified in line_item_ids." "advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, @@ -912,7 +924,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -927,10 +939,41 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` * `THIRD_PARTY_VENDOR_GEMIUS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + }, + }, "displayName": "A String", # Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`. "excludeNewExchanges": True or False, # Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default. @@ -949,7 +992,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -987,7 +1030,7 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. + "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. @@ -1018,25 +1061,25 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_KANTAR_MILLWARD_BROWN` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_KANTAR_MILLWARD_BROWN` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` + "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` * `THIRD_PARTY_VENDOR_GEMIUS` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` + "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1120,6 +1163,12 @@

Method Details

{ # A single line item. "advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, @@ -1143,7 +1192,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -1158,10 +1207,41 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` * `THIRD_PARTY_VENDOR_GEMIUS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + }, + }, "displayName": "A String", # Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`. "excludeNewExchanges": True or False, # Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default. @@ -1180,7 +1260,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -1218,7 +1298,7 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. + "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. @@ -1249,25 +1329,25 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_KANTAR_MILLWARD_BROWN` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_KANTAR_MILLWARD_BROWN` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` + "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` * `THIRD_PARTY_VENDOR_GEMIUS` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` + "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1311,6 +1391,12 @@

Method Details

{ # A single line item. "advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, @@ -1334,7 +1420,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -1349,10 +1435,41 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` * `THIRD_PARTY_VENDOR_GEMIUS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + }, + }, "displayName": "A String", # Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`. "excludeNewExchanges": True or False, # Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default. @@ -1371,7 +1488,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -1409,7 +1526,7 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. + "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. @@ -1440,25 +1557,25 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_KANTAR_MILLWARD_BROWN` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_KANTAR_MILLWARD_BROWN` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` + "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` * `THIRD_PARTY_VENDOR_GEMIUS` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` + "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1557,6 +1674,12 @@

Method Details

{ # A single line item. "advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, @@ -1580,7 +1703,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -1595,10 +1718,41 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` * `THIRD_PARTY_VENDOR_GEMIUS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + }, + }, "displayName": "A String", # Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`. "excludeNewExchanges": True or False, # Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default. @@ -1617,7 +1771,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -1655,7 +1809,7 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. + "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. @@ -1686,25 +1840,25 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_KANTAR_MILLWARD_BROWN` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_KANTAR_MILLWARD_BROWN` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` + "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` * `THIRD_PARTY_VENDOR_GEMIUS` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` + "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1761,6 +1915,12 @@

Method Details

{ # A single line item. "advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, @@ -1784,7 +1944,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -1799,10 +1959,41 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` * `THIRD_PARTY_VENDOR_GEMIUS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + }, + }, "displayName": "A String", # Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`. "excludeNewExchanges": True or False, # Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default. @@ -1821,7 +2012,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -1859,7 +2050,7 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. + "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. @@ -1890,25 +2081,25 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_KANTAR_MILLWARD_BROWN` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_KANTAR_MILLWARD_BROWN` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` + "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` * `THIRD_PARTY_VENDOR_GEMIUS` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` + "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1972,6 +2163,12 @@

Method Details

{ # A single line item. "advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, @@ -1995,7 +2192,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -2010,10 +2207,41 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` * `THIRD_PARTY_VENDOR_GEMIUS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + }, + }, "displayName": "A String", # Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`. "excludeNewExchanges": True or False, # Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default. @@ -2032,7 +2260,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -2070,7 +2298,7 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. + "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. @@ -2101,25 +2329,25 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_KANTAR_MILLWARD_BROWN` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_KANTAR_MILLWARD_BROWN` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` + "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` * `THIRD_PARTY_VENDOR_GEMIUS` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` + "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -2164,6 +2392,12 @@

Method Details

{ # A single line item. "advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. + "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. + "effectiveBiddingValue": "A String", # Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field. + "effectiveBiddingValueSource": "A String", # Output only. Source of the effective bidding value. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set at the line item level. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. + }, "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, @@ -2187,7 +2421,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -2202,10 +2436,41 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` * `THIRD_PARTY_VENDOR_GEMIUS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` + { # Settings that control how third-party measurement vendors are configured. + "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. + "vendor": "A String", # The third-party measurement vendor. + }, + ], + }, + }, "displayName": "A String", # Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes. "entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`. "excludeNewExchanges": True or False, # Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default. @@ -2224,7 +2489,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -2262,7 +2527,7 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. + "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. @@ -2293,25 +2558,25 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_KANTAR_MILLWARD_BROWN` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_KANTAR_MILLWARD_BROWN` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` + "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` * `THIRD_PARTY_VENDOR_GEMIUS` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. }, ], - "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` + "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. diff --git a/docs/dyn/displayvideo_v4.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v4.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html index e2e17f23ed..90401e34d2 100644 --- a/docs/dyn/displayvideo_v4.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v4.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html @@ -287,7 +287,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -327,6 +327,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -621,7 +624,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -661,6 +664,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -1088,7 +1094,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1128,6 +1134,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -1488,7 +1497,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1528,6 +1537,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, diff --git a/docs/dyn/displayvideo_v4.advertisers.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v4.advertisers.targetingTypes.assignedTargetingOptions.html index 7f47b969d6..166274d299 100644 --- a/docs/dyn/displayvideo_v4.advertisers.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v4.advertisers.targetingTypes.assignedTargetingOptions.html @@ -286,7 +286,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -326,6 +326,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -620,7 +623,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -660,6 +663,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -1085,7 +1091,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1125,6 +1131,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -1484,7 +1493,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1524,6 +1533,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, diff --git a/docs/dyn/displayvideo_v4.partners.html b/docs/dyn/displayvideo_v4.partners.html index da1122b00f..0c934dcaa5 100644 --- a/docs/dyn/displayvideo_v4.partners.html +++ b/docs/dyn/displayvideo_v4.partners.html @@ -245,7 +245,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -285,6 +285,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -594,7 +597,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -634,6 +637,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, diff --git a/docs/dyn/displayvideo_v4.partners.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v4.partners.targetingTypes.assignedTargetingOptions.html index 3679e826c5..21072353bf 100644 --- a/docs/dyn/displayvideo_v4.partners.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v4.partners.targetingTypes.assignedTargetingOptions.html @@ -286,7 +286,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -326,6 +326,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -620,7 +623,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -660,6 +663,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -1085,7 +1091,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1125,6 +1131,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, @@ -1484,7 +1493,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1524,6 +1533,9 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "A String", + ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. "negative": True or False, # Indicates if this option is being negatively targeted. }, diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v2.json b/googleapiclient/discovery_cache/documents/displayvideo.v2.json index 467384a793..a83407bbb8 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v2.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v2.json @@ -7981,7 +7981,7 @@ } } }, -"revision": "20260224", +"revision": "20260305", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActivateManualTriggerRequest": { @@ -9280,6 +9280,10 @@ "description": "Settings that control the bid strategy. Bid strategy determines the bid price.", "id": "BiddingStrategy", "properties": { +"demandGenBid": { +"$ref": "DemandGenBiddingStrategy", +"description": "A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity." +}, "fixedBid": { "$ref": "FixedBidStrategy", "description": "A strategy that uses a fixed bid price." @@ -10733,6 +10737,11 @@ "description": "The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000.", "format": "int64", "type": "string" +}, +"primaryAttributionModelId": { +"description": "Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items.", +"format": "int64", +"type": "string" } }, "type": "object" @@ -10957,9 +10966,9 @@ true, true, true, true, -false, -false, -false, +true, +true, +true, false, false, false @@ -11763,7 +11772,7 @@ false "type": "integer" }, "timeZoneResolution": { -"description": "Required. The mechanism used to determine which timezone to use for this day and time targeting setting.", +"description": "Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER.", "enum": [ "TIME_ZONE_RESOLUTION_UNSPECIFIED", "TIME_ZONE_RESOLUTION_END_USER", @@ -11905,6 +11914,79 @@ false }, "type": "object" }, +"DemandGenBiddingStrategy": { +"description": "Settings that control the bid strategy for Demand Gen resources.", +"id": "DemandGenBiddingStrategy", +"properties": { +"effectiveBiddingValue": { +"description": "Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"effectiveBiddingValueSource": { +"description": "Output only. Source of the effective bidding value.", +"enum": [ +"BIDDING_SOURCE_UNSPECIFIED", +"BIDDING_SOURCE_LINE_ITEM", +"BIDDING_SOURCE_AD_GROUP" +], +"enumDescriptions": [ +"Bidding source is not specified or unknown.", +"Bidding value is inherited from the line item.", +"Bidding value is defined in the ad group." +], +"readOnly": true, +"type": "string" +}, +"type": { +"description": "Optional. The type of the bidding strategy. This can only be set at the line item level.", +"enum": [ +"DEMAND_GEN_BIDDING_STRATEGY_TYPE_UNSPECIFIED", +"DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA", +"DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS", +"DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSIONS", +"DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSION_VALUE", +"DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CLICKS" +], +"enumDescriptions": [ +"Type is not specified or unknown.", +"A bidding strategy that automatically optimizes conversions per dollar.", +"A bidding strategy that automatically maximizes revenue while averaging a specific target Return On Ad Spend (ROAS).", +"A bidding strategy that automatically maximizes number of conversions", +"A bidding strategy that automatically maximizes revenue while spending your budget.", +"A bidding strategy that automatically maximizes clicks within a given budget." +], +"type": "string" +}, +"value": { +"description": "Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"DemandGenSettings": { +"description": "Settings for Demand Gen line items.", +"id": "DemandGenSettings", +"properties": { +"geoLanguageTargetingEnabled": { +"description": "Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups.", +"type": "boolean" +}, +"linkedMerchantId": { +"description": "Optional. The ID of the merchant which is linked to the line item for product feed.", +"format": "int64", +"type": "string" +}, +"thirdPartyMeasurementConfigs": { +"$ref": "ThirdPartyMeasurementConfigs", +"description": "Optional. The third party measurement settings for the Demand Gen line item." +} +}, +"type": "object" +}, "DeviceMakeModelAssignedTargetingOptionDetails": { "description": "Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.", "id": "DeviceMakeModelAssignedTargetingOptionDetails", @@ -14430,6 +14512,11 @@ false "description": "Meta data of an image asset.", "id": "ImageAsset", "properties": { +"assetId": { +"description": "Required. The unique ID of the asset.", +"format": "int64", +"type": "string" +}, "fileSize": { "description": "Output only. File size of the image asset in bytes.", "format": "int64", @@ -14630,7 +14717,7 @@ true "Insertion order automation option is not specified or is unknown in this version.", "Automatic budget allocation. Allow the system to automatically shift budget to owning line items to optimize performance defined by kpi. No automation on bid settings.", "No automation of bid or budget on insertion order level. Bid and budget must be manually configured at the line item level.", -"Allow the system to automatically adjust bids and shift budget to owning line items to optimize performance defined by kpi." +"Allow the system to automatically adjust bids and shift budget to owning line items to optimize performance defined by bid_strategy." ], "type": "string" }, @@ -15552,6 +15639,13 @@ true "description": "Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`.", "id": "KeywordAssignedTargetingOptionDetails", "properties": { +"exemptedPolicyNames": { +"description": "Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted.", +"items": { +"type": "string" +}, +"type": "array" +}, "keyword": { "description": "Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.", "type": "string" @@ -15645,6 +15739,10 @@ true }, "type": "array" }, +"demandGenSettings": { +"$ref": "DemandGenSettings", +"description": "Optional. Settings specific to Demand Gen line items." +}, "displayName": { "description": "Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes.", "type": "string" @@ -15679,7 +15777,7 @@ true }, "frequencyCap": { "$ref": "FrequencyCap", -"description": "Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap." +"description": "Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN." }, "insertionOrderId": { "description": "Required. Immutable. The unique ID of the insertion order that the line item belongs to.", @@ -15720,7 +15818,8 @@ true "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_TARGET_FREQUENCY", "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIEW", "LINE_ITEM_TYPE_DISPLAY_OUT_OF_HOME", -"LINE_ITEM_TYPE_VIDEO_OUT_OF_HOME" +"LINE_ITEM_TYPE_VIDEO_OUT_OF_HOME", +"LINE_ITEM_TYPE_DEMAND_GEN" ], "enumDescriptions": [ "Type value is not specified or is unknown in this version. Line items of this type and their targeting cannot be created or updated using the API.", @@ -15744,7 +15843,8 @@ true "The goal of this line item type is to show the YouTube ads target number of times to the same person in a certain period of time. Line items of this type and their targeting cannot be created or updated using the API.", "YouTube video ads that aim to get more views with a variety of ad formats. Line items of this type and their targeting cannot be created or updated using the API.", "Display ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API.", -"Video ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API." +"Video ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API.", +"Demand Gen ads." ], "type": "string" }, @@ -15868,7 +15968,7 @@ true "id": "LineItemBudget", "properties": { "budgetAllocationType": { -"description": "Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order.", +"description": "Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types.", "enum": [ "LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNSPECIFIED", "LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC", @@ -17533,7 +17633,7 @@ true "type": "string" }, "markupType": { -"description": "Required. The markup type of the partner revenue model.", +"description": "Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`.", "enum": [ "PARTNER_REVENUE_MODEL_MARKUP_TYPE_UNSPECIFIED", "PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM", @@ -18204,9 +18304,9 @@ true, true, true, true, -false, -false, -false, +true, +true, +true, false, false, false @@ -18299,9 +18399,9 @@ true, true, true, true, -false, -false, -false, +true, +true, +true, false, false, false @@ -18926,6 +19026,41 @@ true }, "type": "object" }, +"ThirdPartyMeasurementConfigs": { +"description": "Settings that control what third-party vendors are measuring specific line item metrics.", +"id": "ThirdPartyMeasurementConfigs", +"properties": { +"brandLiftVendorConfigs": { +"description": "Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL`", +"items": { +"$ref": "ThirdPartyVendorConfig" +}, +"type": "array" +}, +"brandSafetyVendorConfigs": { +"description": "Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR`", +"items": { +"$ref": "ThirdPartyVendorConfig" +}, +"type": "array" +}, +"reachVendorConfigs": { +"description": "Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` * `THIRD_PARTY_VENDOR_GEMIUS`", +"items": { +"$ref": "ThirdPartyVendorConfig" +}, +"type": "array" +}, +"viewabilityVendorConfigs": { +"description": "Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS`", +"items": { +"$ref": "ThirdPartyVendorConfig" +}, +"type": "array" +} +}, +"type": "object" +}, "ThirdPartyOnlyConfig": { "description": "Settings for advertisers that use third-party ad servers only.", "id": "ThirdPartyOnlyConfig", @@ -19010,7 +19145,16 @@ true "THIRD_PARTY_VENDOR_NIELSEN", "THIRD_PARTY_VENDOR_KANTAR", "THIRD_PARTY_VENDOR_DYNATA", -"THIRD_PARTY_VENDOR_TRANSUNION" +"THIRD_PARTY_VENDOR_TRANSUNION", +"THIRD_PARTY_VENDOR_ORIGIN", +"THIRD_PARTY_VENDOR_GEMIUS", +"THIRD_PARTY_VENDOR_MEDIA_SCOPE", +"THIRD_PARTY_VENDOR_AUDIENCE_PROJECT", +"THIRD_PARTY_VENDOR_VIDEO_AMP", +"THIRD_PARTY_VENDOR_ISPOT_TV", +"THIRD_PARTY_VENDOR_INTAGE", +"THIRD_PARTY_VENDOR_MACROMILL", +"THIRD_PARTY_VENDOR_VIDEO_RESEARCH" ], "enumDescriptions": [ "Unknown third-party vendor.", @@ -19024,7 +19168,16 @@ true "Nielsen.", "Kantar.", "Dynata.", -"Transunion." +"Transunion.", +"Origin.", +"Gemius.", +"MediaScope.", +"Audience Project.", +"Video Amp.", +"Ispot TV.", +"Intage.", +"Macromill.", +"Video Research." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v3.json b/googleapiclient/discovery_cache/documents/displayvideo.v3.json index a75ff2b9a2..e0c57bb67b 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v3.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v3.json @@ -376,6 +376,70 @@ "resources": { "adGroupAds": { "methods": { +"create": { +"description": "Creates an ad group ad.", +"flatPath": "v3/advertisers/{advertisersId}/adGroupAds", +"httpMethod": "POST", +"id": "displayvideo.advertisers.adGroupAds.create", +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "Output only. The unique ID of the advertiser the ad belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v3/advertisers/{+advertiserId}/adGroupAds", +"request": { +"$ref": "AdGroupAd" +}, +"response": { +"$ref": "AdGroupAd" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"delete": { +"description": "Deletes an ad group ad.", +"flatPath": "v3/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}", +"httpMethod": "DELETE", +"id": "displayvideo.advertisers.adGroupAds.delete", +"parameterOrder": [ +"advertiserId", +"adGroupAdId" +], +"parameters": { +"adGroupAdId": { +"description": "Required. The ID of the ad to delete.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"advertiserId": { +"description": "Required. The ID of the advertiser the ad belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v3/advertisers/{+advertiserId}/adGroupAds/{+adGroupAdId}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, "get": { "description": "Gets an ad group ad.", "flatPath": "v3/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}", @@ -457,11 +521,84 @@ "scopes": [ "https://www.googleapis.com/auth/display-video" ] +}, +"patch": { +"description": "Updates an ad group ad.", +"flatPath": "v3/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}", +"httpMethod": "PATCH", +"id": "displayvideo.advertisers.adGroupAds.patch", +"parameterOrder": [ +"advertiserId", +"adGroupAdId" +], +"parameters": { +"adGroupAdId": { +"description": "Output only. The unique ID of the ad. Assigned by the system.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"advertiserId": { +"description": "Output only. The unique ID of the advertiser the ad belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. The mask to control which fields to update.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v3/advertisers/{+advertiserId}/adGroupAds/{+adGroupAdId}", +"request": { +"$ref": "AdGroupAd" +}, +"response": { +"$ref": "AdGroupAd" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] } } }, "adGroups": { "methods": { +"bulkEditAssignedTargetingOptions": { +"description": "Bulk edits targeting options for multiple ad groups. The same set of delete and create requests will be applied to all specified ad groups. Specifically, the operation will delete the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.delete_requests from each ad group, and then create the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.create_requests. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.", +"flatPath": "v3/advertisers/{advertisersId}/adGroups:bulkEditAssignedTargetingOptions", +"httpMethod": "POST", +"id": "displayvideo.advertisers.adGroups.bulkEditAssignedTargetingOptions", +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the advertiser the ad groups belong to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v3/advertisers/{+advertiserId}/adGroups:bulkEditAssignedTargetingOptions", +"request": { +"$ref": "BulkEditAdGroupAssignedTargetingOptionsRequest" +}, +"response": { +"$ref": "BulkEditAdGroupAssignedTargetingOptionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, "bulkListAdGroupAssignedTargetingOptions": { "description": "Lists assigned targeting options for multiple ad groups across targeting types. Inherited assigned targeting options are not included.", "flatPath": "v3/advertisers/{advertisersId}/adGroups:bulkListAdGroupAssignedTargetingOptions", @@ -516,6 +653,70 @@ "https://www.googleapis.com/auth/display-video" ] }, +"create": { +"description": "Creates a new ad group. Returns the newly created ad group if successful.", +"flatPath": "v3/advertisers/{advertisersId}/adGroups", +"httpMethod": "POST", +"id": "displayvideo.advertisers.adGroups.create", +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "Output only. The unique ID of the advertiser the ad group belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v3/advertisers/{+advertiserId}/adGroups", +"request": { +"$ref": "AdGroup" +}, +"response": { +"$ref": "AdGroup" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"delete": { +"description": "Deletes a AdGroup. Returns error code `NOT_FOUND` if the ad group does not exist.", +"flatPath": "v3/advertisers/{advertisersId}/adGroups/{adGroupsId}", +"httpMethod": "DELETE", +"id": "displayvideo.advertisers.adGroups.delete", +"parameterOrder": [ +"advertiserId", +"adGroupId" +], +"parameters": { +"adGroupId": { +"description": "Required. The ID of the ad group to delete.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"advertiserId": { +"description": "Required. The ID of the advertiser this ad group belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, "get": { "description": "Gets an ad group.", "flatPath": "v3/advertisers/{advertisersId}/adGroups/{adGroupsId}", @@ -597,6 +798,50 @@ "scopes": [ "https://www.googleapis.com/auth/display-video" ] +}, +"patch": { +"description": "Updates an existing ad group. Returns the updated ad group if successful.", +"flatPath": "v3/advertisers/{advertisersId}/adGroups/{adGroupsId}", +"httpMethod": "PATCH", +"id": "displayvideo.advertisers.adGroups.patch", +"parameterOrder": [ +"advertiserId", +"adGroupId" +], +"parameters": { +"adGroupId": { +"description": "Output only. The unique ID of the ad group. Assigned by the system.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"advertiserId": { +"description": "Output only. The unique ID of the advertiser the ad group belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. The mask to control which fields to update.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}", +"request": { +"$ref": "AdGroup" +}, +"response": { +"$ref": "AdGroup" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] } }, "resources": { @@ -604,20 +849,19 @@ "resources": { "assignedTargetingOptions": { "methods": { -"get": { -"description": "Gets a single targeting option assigned to an ad group. Inherited assigned targeting options are not included.", -"flatPath": "v3/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}", -"httpMethod": "GET", -"id": "displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.get", +"create": { +"description": "Assigns a targeting option to an ad group. Returns the assigned targeting option if successful. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.", +"flatPath": "v3/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions", +"httpMethod": "POST", +"id": "displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.create", "parameterOrder": [ "advertiserId", "adGroupId", -"targetingType", -"assignedTargetingOptionId" +"targetingType" ], "parameters": { "adGroupId": { -"description": "Required. The ID of the ad group the assigned targeting option belongs to.", +"description": "Required. The ID of the ad group the assigned targeting option will belong to.", "format": "int64", "location": "path", "pattern": "^[^/]+$", @@ -632,15 +876,8 @@ "required": true, "type": "string" }, -"assignedTargetingOptionId": { -"description": "Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested.", -"location": "path", -"pattern": "^[^/]+$", -"required": true, -"type": "string" -}, "targetingType": { -"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`", +"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`", "enum": [ "TARGETING_TYPE_UNSPECIFIED", "TARGETING_TYPE_CHANNEL", @@ -751,7 +988,10 @@ "type": "string" } }, -"path": "v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}", +"path": "v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions", +"request": { +"$ref": "AssignedTargetingOption" +}, "response": { "$ref": "AssignedTargetingOption" }, @@ -759,19 +999,20 @@ "https://www.googleapis.com/auth/display-video" ] }, -"list": { -"description": "Lists the targeting options assigned to an ad group. Inherited assigned targeting options are not included.", -"flatPath": "v3/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions", -"httpMethod": "GET", -"id": "displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.list", +"delete": { +"description": "Deletes an assigned targeting option from an ad group. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.", +"flatPath": "v3/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}", +"httpMethod": "DELETE", +"id": "displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.delete", "parameterOrder": [ "advertiserId", "adGroupId", -"targetingType" +"targetingType", +"assignedTargetingOptionId" ], "parameters": { "adGroupId": { -"description": "Required. The ID of the ad group to list assigned targeting options for.", +"description": "Required. The ID of the ad group the assigned targeting option belongs to.", "format": "int64", "location": "path", "pattern": "^[^/]+$", @@ -786,29 +1027,15 @@ "required": true, "type": "string" }, -"filter": { -"description": "Optional. Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId=\"1\" OR assignedTargetingOptionId=\"2\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", -"location": "query", -"type": "string" -}, -"orderBy": { -"description": "Optional. Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `assignedTargetingOptionId desc`.", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "Optional. Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroupAssignedTargetingOptions` method. If not specified, the first page of results will be returned.", -"location": "query", +"assignedTargetingOptionId": { +"description": "Required. The ID of the assigned targeting option to delete.", +"location": "path", +"pattern": "^[^/]+$", +"required": true, "type": "string" }, "targetingType": { -"description": "Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`", +"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`", "enum": [ "TARGETING_TYPE_UNSPECIFIED", "TARGETING_TYPE_CHANNEL", @@ -919,131 +1146,454 @@ "type": "string" } }, -"path": "v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions", +"path": "v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}", "response": { -"$ref": "ListAdGroupAssignedTargetingOptionsResponse" +"$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/display-video" ] -} -} -} -} -} -} -}, -"assets": { -"methods": { -"upload": { -"description": "Uploads an asset. Returns the ID of the newly uploaded asset if successful. The asset file size should be no more than 10 MB for images, 200 MB for ZIP files, and 1 GB for videos. Must be used within the [multipart media upload process](/display-video/api/guides/how-tos/upload#multipart). Examples using provided client libraries can be found in our [Creating Creatives guide](/display-video/api/guides/creating-creatives/overview#upload_an_asset).", -"flatPath": "v3/advertisers/{advertisersId}/assets", -"httpMethod": "POST", -"id": "displayvideo.advertisers.assets.upload", -"mediaUpload": { -"accept": [ -"*/*" -], -"protocols": { -"simple": { -"multipart": true, -"path": "/upload/v3/advertisers/{+advertiserId}/assets" -} -} }, +"get": { +"description": "Gets a single targeting option assigned to an ad group. Inherited assigned targeting options are not included.", +"flatPath": "v3/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}", +"httpMethod": "GET", +"id": "displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.get", "parameterOrder": [ -"advertiserId" +"advertiserId", +"adGroupId", +"targetingType", +"assignedTargetingOptionId" ], "parameters": { -"advertiserId": { -"description": "Required. The ID of the advertiser this asset belongs to.", +"adGroupId": { +"description": "Required. The ID of the ad group the assigned targeting option belongs to.", "format": "int64", "location": "path", "pattern": "^[^/]+$", "required": true, "type": "string" -} }, -"path": "v3/advertisers/{+advertiserId}/assets", -"request": { -"$ref": "CreateAssetRequest" +"advertiserId": { +"description": "Required. The ID of the advertiser the ad group belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" }, -"response": { -"$ref": "CreateAssetResponse" +"assignedTargetingOptionId": { +"description": "Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested.", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" }, -"scopes": [ -"https://www.googleapis.com/auth/display-video" +"targetingType": { +"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`", +"enum": [ +"TARGETING_TYPE_UNSPECIFIED", +"TARGETING_TYPE_CHANNEL", +"TARGETING_TYPE_APP_CATEGORY", +"TARGETING_TYPE_APP", +"TARGETING_TYPE_URL", +"TARGETING_TYPE_DAY_AND_TIME", +"TARGETING_TYPE_AGE_RANGE", +"TARGETING_TYPE_REGIONAL_LOCATION_LIST", +"TARGETING_TYPE_PROXIMITY_LOCATION_LIST", +"TARGETING_TYPE_GENDER", +"TARGETING_TYPE_VIDEO_PLAYER_SIZE", +"TARGETING_TYPE_USER_REWARDED_CONTENT", +"TARGETING_TYPE_PARENTAL_STATUS", +"TARGETING_TYPE_CONTENT_INSTREAM_POSITION", +"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", +"TARGETING_TYPE_DEVICE_TYPE", +"TARGETING_TYPE_AUDIENCE_GROUP", +"TARGETING_TYPE_BROWSER", +"TARGETING_TYPE_HOUSEHOLD_INCOME", +"TARGETING_TYPE_ON_SCREEN_POSITION", +"TARGETING_TYPE_THIRD_PARTY_VERIFIER", +"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", +"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", +"TARGETING_TYPE_ENVIRONMENT", +"TARGETING_TYPE_CARRIER_AND_ISP", +"TARGETING_TYPE_OPERATING_SYSTEM", +"TARGETING_TYPE_DEVICE_MAKE_MODEL", +"TARGETING_TYPE_KEYWORD", +"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", +"TARGETING_TYPE_VIEWABILITY", +"TARGETING_TYPE_CATEGORY", +"TARGETING_TYPE_INVENTORY_SOURCE", +"TARGETING_TYPE_LANGUAGE", +"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", +"TARGETING_TYPE_GEO_REGION", +"TARGETING_TYPE_INVENTORY_SOURCE_GROUP", +"TARGETING_TYPE_EXCHANGE", +"TARGETING_TYPE_SUB_EXCHANGE", +"TARGETING_TYPE_POI", +"TARGETING_TYPE_BUSINESS_CHAIN", +"TARGETING_TYPE_CONTENT_DURATION", +"TARGETING_TYPE_CONTENT_STREAM_TYPE", +"TARGETING_TYPE_NATIVE_CONTENT_POSITION", +"TARGETING_TYPE_OMID", +"TARGETING_TYPE_AUDIO_CONTENT_TYPE", +"TARGETING_TYPE_CONTENT_GENRE", +"TARGETING_TYPE_YOUTUBE_VIDEO", +"TARGETING_TYPE_YOUTUBE_CHANNEL", +"TARGETING_TYPE_SESSION_POSITION", +"TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], -"supportsMediaUpload": true -} -} -}, -"campaigns": { -"methods": { -"create": { -"description": "Creates a new campaign. Returns the newly created campaign if successful.", -"flatPath": "v3/advertisers/{advertisersId}/campaigns", -"httpMethod": "POST", -"id": "displayvideo.advertisers.campaigns.create", -"parameterOrder": [ -"advertiserId" +"enumDescriptions": [ +"Default value when type is not specified or is unknown in this version.", +"Target a channel (a custom group of related websites or apps).", +"Target an app category (for example, education or puzzle games).", +"Target a specific app (for example, Angry Birds).", +"Target a specific url (for example, quora.com).", +"Target ads during a chosen time period on a specific day.", +"Target ads to a specific age range (for example, 18-24).", +"Target ads to the specified regions on a regional location list.", +"Target ads to the specified points of interest on a proximity location list.", +"Target ads to a specific gender (for example, female or male).", +"Target a specific video player size for video ads.", +"Target user rewarded content for video ads.", +"Target ads to a specific parental status (for example, parent or not a parent).", +"Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", +"Target ads in a specific content outstream position.", +"Target ads to a specific device type (for example, tablet or connected TV).", +"Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", +"Target ads to specific web browsers (for example, Chrome).", +"Target ads to a specific household income range (for example, top 10%).", +"Target ads in a specific on screen position.", +"Filter web sites through third party verification (for example, IAS or DoubleVerify).", +"Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", +"Filter website content by sensitive categories (for example, adult).", +"Target ads to a specific environment (for example, web or app).", +"Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", +"Target ads to a specific operating system (for example, macOS).", +"Target ads to a specific device make or model (for example, Roku or Samsung).", +"Target ads to a specific keyword (for example, dog or retriever).", +"Target ads to a specific negative keyword list.", +"Target ads to a specific viewability (for example, 80% viewable).", +"Target ads to a specific content category (for example, arts & entertainment).", +"Purchase impressions from specific deals and auction packages.", +"Target ads to a specific language (for example, English or Japanese).", +"Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", +"Target ads to a specific regional location (for example, a city or state).", +"Purchase impressions from a group of deals and auction packages.", +"Purchase impressions from specific exchanges.", +"Purchase impressions from specific sub-exchanges.", +"Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", +"Target ads around locations of a business chain within a specific geo region.", +"Target ads to a specific video content duration.", +"Target ads to a specific video content stream type.", +"Target ads to a specific native content position.", +"Target ads in an Open Measurement enabled inventory.", +"Target ads to a specific audio content type.", +"Target ads to a specific content genre.", +"Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.", +"Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources." ], -"parameters": { -"advertiserId": { -"description": "Output only. The unique ID of the advertiser the campaign belongs to.", -"format": "int64", "location": "path", "pattern": "^[^/]+$", "required": true, "type": "string" } }, -"path": "v3/advertisers/{+advertiserId}/campaigns", -"request": { -"$ref": "Campaign" -}, +"path": "v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}", "response": { -"$ref": "Campaign" +"$ref": "AssignedTargetingOption" }, "scopes": [ -"https://www.googleapis.com/auth/display-video", -"https://www.googleapis.com/auth/display-video-mediaplanning" +"https://www.googleapis.com/auth/display-video" ] }, -"delete": { -"description": "Permanently deletes a campaign. A deleted campaign cannot be recovered. The campaign should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.", -"flatPath": "v3/advertisers/{advertisersId}/campaigns/{campaignsId}", -"httpMethod": "DELETE", -"id": "displayvideo.advertisers.campaigns.delete", +"list": { +"description": "Lists the targeting options assigned to an ad group. Inherited assigned targeting options are not included.", +"flatPath": "v3/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions", +"httpMethod": "GET", +"id": "displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.list", "parameterOrder": [ "advertiserId", -"campaignId" +"adGroupId", +"targetingType" ], "parameters": { -"advertiserId": { -"description": "The ID of the advertiser this campaign belongs to.", +"adGroupId": { +"description": "Required. The ID of the ad group to list assigned targeting options for.", "format": "int64", "location": "path", "pattern": "^[^/]+$", "required": true, "type": "string" }, -"campaignId": { -"description": "The ID of the campaign we need to delete.", +"advertiserId": { +"description": "Required. The ID of the advertiser the ad group belongs to.", "format": "int64", "location": "path", "pattern": "^[^/]+$", "required": true, "type": "string" -} }, -"path": "v3/advertisers/{+advertiserId}/campaigns/{+campaignId}", -"response": { -"$ref": "Empty" +"filter": { +"description": "Optional. Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId=\"1\" OR assignedTargetingOptionId=\"2\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", +"location": "query", +"type": "string" }, -"scopes": [ -"https://www.googleapis.com/auth/display-video", -"https://www.googleapis.com/auth/display-video-mediaplanning" +"orderBy": { +"description": "Optional. Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `assignedTargetingOptionId desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroupAssignedTargetingOptions` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +}, +"targetingType": { +"description": "Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`", +"enum": [ +"TARGETING_TYPE_UNSPECIFIED", +"TARGETING_TYPE_CHANNEL", +"TARGETING_TYPE_APP_CATEGORY", +"TARGETING_TYPE_APP", +"TARGETING_TYPE_URL", +"TARGETING_TYPE_DAY_AND_TIME", +"TARGETING_TYPE_AGE_RANGE", +"TARGETING_TYPE_REGIONAL_LOCATION_LIST", +"TARGETING_TYPE_PROXIMITY_LOCATION_LIST", +"TARGETING_TYPE_GENDER", +"TARGETING_TYPE_VIDEO_PLAYER_SIZE", +"TARGETING_TYPE_USER_REWARDED_CONTENT", +"TARGETING_TYPE_PARENTAL_STATUS", +"TARGETING_TYPE_CONTENT_INSTREAM_POSITION", +"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", +"TARGETING_TYPE_DEVICE_TYPE", +"TARGETING_TYPE_AUDIENCE_GROUP", +"TARGETING_TYPE_BROWSER", +"TARGETING_TYPE_HOUSEHOLD_INCOME", +"TARGETING_TYPE_ON_SCREEN_POSITION", +"TARGETING_TYPE_THIRD_PARTY_VERIFIER", +"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", +"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", +"TARGETING_TYPE_ENVIRONMENT", +"TARGETING_TYPE_CARRIER_AND_ISP", +"TARGETING_TYPE_OPERATING_SYSTEM", +"TARGETING_TYPE_DEVICE_MAKE_MODEL", +"TARGETING_TYPE_KEYWORD", +"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", +"TARGETING_TYPE_VIEWABILITY", +"TARGETING_TYPE_CATEGORY", +"TARGETING_TYPE_INVENTORY_SOURCE", +"TARGETING_TYPE_LANGUAGE", +"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", +"TARGETING_TYPE_GEO_REGION", +"TARGETING_TYPE_INVENTORY_SOURCE_GROUP", +"TARGETING_TYPE_EXCHANGE", +"TARGETING_TYPE_SUB_EXCHANGE", +"TARGETING_TYPE_POI", +"TARGETING_TYPE_BUSINESS_CHAIN", +"TARGETING_TYPE_CONTENT_DURATION", +"TARGETING_TYPE_CONTENT_STREAM_TYPE", +"TARGETING_TYPE_NATIVE_CONTENT_POSITION", +"TARGETING_TYPE_OMID", +"TARGETING_TYPE_AUDIO_CONTENT_TYPE", +"TARGETING_TYPE_CONTENT_GENRE", +"TARGETING_TYPE_YOUTUBE_VIDEO", +"TARGETING_TYPE_YOUTUBE_CHANNEL", +"TARGETING_TYPE_SESSION_POSITION", +"TARGETING_TYPE_CONTENT_THEME_EXCLUSION" +], +"enumDescriptions": [ +"Default value when type is not specified or is unknown in this version.", +"Target a channel (a custom group of related websites or apps).", +"Target an app category (for example, education or puzzle games).", +"Target a specific app (for example, Angry Birds).", +"Target a specific url (for example, quora.com).", +"Target ads during a chosen time period on a specific day.", +"Target ads to a specific age range (for example, 18-24).", +"Target ads to the specified regions on a regional location list.", +"Target ads to the specified points of interest on a proximity location list.", +"Target ads to a specific gender (for example, female or male).", +"Target a specific video player size for video ads.", +"Target user rewarded content for video ads.", +"Target ads to a specific parental status (for example, parent or not a parent).", +"Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", +"Target ads in a specific content outstream position.", +"Target ads to a specific device type (for example, tablet or connected TV).", +"Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", +"Target ads to specific web browsers (for example, Chrome).", +"Target ads to a specific household income range (for example, top 10%).", +"Target ads in a specific on screen position.", +"Filter web sites through third party verification (for example, IAS or DoubleVerify).", +"Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", +"Filter website content by sensitive categories (for example, adult).", +"Target ads to a specific environment (for example, web or app).", +"Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", +"Target ads to a specific operating system (for example, macOS).", +"Target ads to a specific device make or model (for example, Roku or Samsung).", +"Target ads to a specific keyword (for example, dog or retriever).", +"Target ads to a specific negative keyword list.", +"Target ads to a specific viewability (for example, 80% viewable).", +"Target ads to a specific content category (for example, arts & entertainment).", +"Purchase impressions from specific deals and auction packages.", +"Target ads to a specific language (for example, English or Japanese).", +"Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", +"Target ads to a specific regional location (for example, a city or state).", +"Purchase impressions from a group of deals and auction packages.", +"Purchase impressions from specific exchanges.", +"Purchase impressions from specific sub-exchanges.", +"Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", +"Target ads around locations of a business chain within a specific geo region.", +"Target ads to a specific video content duration.", +"Target ads to a specific video content stream type.", +"Target ads to a specific native content position.", +"Target ads in an Open Measurement enabled inventory.", +"Target ads to a specific audio content type.", +"Target ads to a specific content genre.", +"Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.", +"Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources." +], +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions", +"response": { +"$ref": "ListAdGroupAssignedTargetingOptionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +} +} +} +} +} +} +}, +"assets": { +"methods": { +"upload": { +"description": "Uploads an asset. Returns the ID of the newly uploaded asset if successful. The asset file size should be no more than 10 MB for images, 200 MB for ZIP files, and 1 GB for videos. Must be used within the [multipart media upload process](/display-video/api/guides/how-tos/upload#multipart). Examples using provided client libraries can be found in our [Creating Creatives guide](/display-video/api/guides/creating-creatives/overview#upload_an_asset).", +"flatPath": "v3/advertisers/{advertisersId}/assets", +"httpMethod": "POST", +"id": "displayvideo.advertisers.assets.upload", +"mediaUpload": { +"accept": [ +"*/*" +], +"protocols": { +"simple": { +"multipart": true, +"path": "/upload/v3/advertisers/{+advertiserId}/assets" +} +} +}, +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the advertiser this asset belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v3/advertisers/{+advertiserId}/assets", +"request": { +"$ref": "CreateAssetRequest" +}, +"response": { +"$ref": "CreateAssetResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +], +"supportsMediaUpload": true +} +} +}, +"campaigns": { +"methods": { +"create": { +"description": "Creates a new campaign. Returns the newly created campaign if successful.", +"flatPath": "v3/advertisers/{advertisersId}/campaigns", +"httpMethod": "POST", +"id": "displayvideo.advertisers.campaigns.create", +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "Output only. The unique ID of the advertiser the campaign belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v3/advertisers/{+advertiserId}/campaigns", +"request": { +"$ref": "Campaign" +}, +"response": { +"$ref": "Campaign" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video", +"https://www.googleapis.com/auth/display-video-mediaplanning" +] +}, +"delete": { +"description": "Permanently deletes a campaign. A deleted campaign cannot be recovered. The campaign should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.", +"flatPath": "v3/advertisers/{advertisersId}/campaigns/{campaignsId}", +"httpMethod": "DELETE", +"id": "displayvideo.advertisers.campaigns.delete", +"parameterOrder": [ +"advertiserId", +"campaignId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser this campaign belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"campaignId": { +"description": "The ID of the campaign we need to delete.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v3/advertisers/{+advertiserId}/campaigns/{+campaignId}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video", +"https://www.googleapis.com/auth/display-video-mediaplanning" ] }, "get": { @@ -8156,7 +8706,7 @@ } } }, -"revision": "20260224", +"revision": "20260305", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActiveViewVideoViewabilityMetricConfig": { @@ -8289,7 +8839,8 @@ "AD_GROUP_FORMAT_AUDIO", "AD_GROUP_FORMAT_RESPONSIVE", "AD_GROUP_FORMAT_REACH", -"AD_GROUP_FORMAT_MASTHEAD" +"AD_GROUP_FORMAT_MASTHEAD", +"AD_GROUP_FORMAT_DEMAND_GEN" ], "enumDescriptions": [ "Format value is not specified or is unknown in this version.", @@ -8300,7 +8851,8 @@ "Non-skippable in-stream audio ads.", "Responsive ads.", "[Effective reach ad groups] (https://support.google.com/displayvideo/answer/9173684), including in-stream and bumper ads.", -"Masthead Ad that is surfaced on the top slot on the YouTube homepage." +"Masthead Ad that is surfaced on the top slot on the YouTube homepage.", +"Demand Gen ads." ], "type": "string" }, @@ -8310,6 +8862,10 @@ "readOnly": true, "type": "string" }, +"adGroupInventoryControl": { +"$ref": "AdGroupInventoryControl", +"description": "Optional. Specifies the inventory control of the ad group. This field is required for Demand Gen ad groups." +}, "advertiserId": { "description": "Output only. The unique ID of the advertiser the ad group belongs to.", "format": "int64", @@ -8409,8 +8965,24 @@ "description": "Output only. Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach.", "readOnly": true }, -"displayName": { -"description": "Required. The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes.", +"demandGenCarouselAd": { +"$ref": "DemandGenCarouselAd", +"description": "Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd)." +}, +"demandGenImageAd": { +"$ref": "DemandGenImageAd", +"description": "Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd)." +}, +"demandGenProductAd": { +"$ref": "DemandGenProductAd", +"description": "Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd)." +}, +"demandGenVideoAd": { +"$ref": "DemandGenVideoAd", +"description": "Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd)." +}, +"displayName": { +"description": "Required. The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes.", "type": "string" }, "displayVideoSourceAd": { @@ -8487,6 +9059,31 @@ }, "type": "object" }, +"AdGroupInventoryControl": { +"description": "The inventory control of the ad group.", +"id": "AdGroupInventoryControl", +"properties": { +"adGroupInventoryStrategy": { +"description": "The inventory strategy.", +"enum": [ +"AD_GROUP_INVENTORY_STRATEGY_UNSPECIFIED", +"AD_GROUP_INVENTORY_STRATEGY_ALL_GOOGLE_AND_DISPLAY_NETWORK_INVENTORY", +"AD_GROUP_INVENTORY_STRATEGY_ALL_GOOGLE_INVENTORY" +], +"enumDescriptions": [ +"Not specified or unknown.", +"The ad group is opted-in to all Google and Display Network inventory.", +"The ad group is opted-in to all Google inventory." +], +"type": "string" +}, +"selectedInventories": { +"$ref": "SelectedInventories", +"description": "The selected inventories." +} +}, +"type": "object" +}, "AdPolicy": { "description": "A single ad policy associated with an ad group ad.", "id": "AdPolicy", @@ -11150,6 +11747,10 @@ "description": "Settings that control the bid strategy. Bid strategy determines the bid price.", "id": "BiddingStrategy", "properties": { +"demandGenBid": { +"$ref": "DemandGenBiddingStrategy", +"description": "A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity." +}, "fixedBid": { "$ref": "FixedBidStrategy", "description": "A strategy that uses a fixed bid price." @@ -11231,6 +11832,68 @@ }, "type": "object" }, +"BulkEditAdGroupAssignedTargetingOptionsRequest": { +"description": "Request message for BulkEditAdGroupAssignedTargetingOptions.", +"id": "BulkEditAdGroupAssignedTargetingOptionsRequest", +"properties": { +"adGroupIds": { +"description": "Required. The IDs of the ad groups the assigned targeting options will belong to. A maximum of 25 ad group IDs can be specified.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +}, +"createRequests": { +"description": "Optional. The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionRequest`. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`", +"items": { +"$ref": "CreateAssignedTargetingOptionsRequest" +}, +"type": "array" +}, +"deleteRequests": { +"description": "Optional. The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`", +"items": { +"$ref": "DeleteAssignedTargetingOptionsRequest" +}, +"type": "array" +} +}, +"type": "object" +}, +"BulkEditAdGroupAssignedTargetingOptionsResponse": { +"description": "Response message for BulkEditAssignedTargetingOptions.", +"id": "BulkEditAdGroupAssignedTargetingOptionsResponse", +"properties": { +"errors": { +"description": "Output only. The error information for each ad group that failed to update.", +"items": { +"$ref": "Status" +}, +"readOnly": true, +"type": "array" +}, +"failedAdGroupIds": { +"description": "Output only. The IDs of the ad groups which failed to update.", +"items": { +"format": "int64", +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"updatedAdGroupIds": { +"description": "Output only. The IDs of the ad groups which were successfully updated.", +"items": { +"format": "int64", +"type": "string" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, "BulkEditAdvertiserAssignedTargetingOptionsRequest": { "description": "Request message for BulkEditAdvertiserAssignedTargetingOptions.", "id": "BulkEditAdvertiserAssignedTargetingOptionsRequest", @@ -12013,6 +12676,41 @@ }, "type": "object" }, +"CarouselCard": { +"description": "Details for a Demand Gen carousel card.", +"id": "CarouselCard", +"properties": { +"callToAction": { +"description": "Required. The call-to-action button shown on the card. Must use 10 characters or less.", +"type": "string" +}, +"finalMobileUrl": { +"description": "Optional. The URL address of the webpage that people reach after they click the card on a mobile device.", +"type": "string" +}, +"finalUrl": { +"description": "Required. The URL address of the webpage that people reach after they click the card.", +"type": "string" +}, +"headline": { +"description": "Required. The headline of the card.", +"type": "string" +}, +"marketingImage": { +"$ref": "ImageAsset", +"description": "Optional. The marketing image shown on the card." +}, +"portraitMarketingImage": { +"$ref": "ImageAsset", +"description": "Optional. The portrait marketing image shown on the card." +}, +"squareMarketingImage": { +"$ref": "ImageAsset", +"description": "Optional. The square marketing image shown on the card." +} +}, +"type": "object" +}, "CarrierAndIspAssignedTargetingOptionDetails": { "description": "Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.", "id": "CarrierAndIspAssignedTargetingOptionDetails", @@ -12804,6 +13502,11 @@ "description": "The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000.", "format": "int64", "type": "string" +}, +"primaryAttributionModelId": { +"description": "Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items.", +"format": "int64", +"type": "string" } }, "type": "object" @@ -13030,9 +13733,9 @@ true, true, true, true, -false, -false, -false, +true, +true, +true, false, false, false @@ -13955,179 +14658,621 @@ false }, "type": "object" }, -"DayAndTimeAssignedTargetingOptionDetails": { -"description": "Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`.", -"id": "DayAndTimeAssignedTargetingOptionDetails", +"DayAndTimeAssignedTargetingOptionDetails": { +"description": "Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`.", +"id": "DayAndTimeAssignedTargetingOptionDetails", +"properties": { +"dayOfWeek": { +"description": "Required. The day of the week for this day and time targeting setting.", +"enum": [ +"DAY_OF_WEEK_UNSPECIFIED", +"MONDAY", +"TUESDAY", +"WEDNESDAY", +"THURSDAY", +"FRIDAY", +"SATURDAY", +"SUNDAY" +], +"enumDescriptions": [ +"The day of the week is unspecified.", +"Monday", +"Tuesday", +"Wednesday", +"Thursday", +"Friday", +"Saturday", +"Sunday" +], +"type": "string" +}, +"endHour": { +"description": "Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).", +"format": "int32", +"type": "integer" +}, +"startHour": { +"description": "Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).", +"format": "int32", +"type": "integer" +}, +"timeZoneResolution": { +"description": "Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER.", +"enum": [ +"TIME_ZONE_RESOLUTION_UNSPECIFIED", +"TIME_ZONE_RESOLUTION_END_USER", +"TIME_ZONE_RESOLUTION_ADVERTISER" +], +"enumDescriptions": [ +"Time zone resolution is either unspecific or unknown.", +"Times are resolved in the time zone of the user that saw the ad.", +"Times are resolved in the time zone of the advertiser that served the ad." +], +"type": "string" +} +}, +"type": "object" +}, +"DeleteAssignedTargetingOptionsRequest": { +"description": "A request listing which assigned targeting options of a given targeting type should be deleted.", +"id": "DeleteAssignedTargetingOptionsRequest", +"properties": { +"assignedTargetingOptionIds": { +"description": "Required. The assigned targeting option IDs to delete.", +"items": { +"type": "string" +}, +"type": "array" +}, +"targetingType": { +"description": "Required. Identifies the type of this assigned targeting option.", +"enum": [ +"TARGETING_TYPE_UNSPECIFIED", +"TARGETING_TYPE_CHANNEL", +"TARGETING_TYPE_APP_CATEGORY", +"TARGETING_TYPE_APP", +"TARGETING_TYPE_URL", +"TARGETING_TYPE_DAY_AND_TIME", +"TARGETING_TYPE_AGE_RANGE", +"TARGETING_TYPE_REGIONAL_LOCATION_LIST", +"TARGETING_TYPE_PROXIMITY_LOCATION_LIST", +"TARGETING_TYPE_GENDER", +"TARGETING_TYPE_VIDEO_PLAYER_SIZE", +"TARGETING_TYPE_USER_REWARDED_CONTENT", +"TARGETING_TYPE_PARENTAL_STATUS", +"TARGETING_TYPE_CONTENT_INSTREAM_POSITION", +"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", +"TARGETING_TYPE_DEVICE_TYPE", +"TARGETING_TYPE_AUDIENCE_GROUP", +"TARGETING_TYPE_BROWSER", +"TARGETING_TYPE_HOUSEHOLD_INCOME", +"TARGETING_TYPE_ON_SCREEN_POSITION", +"TARGETING_TYPE_THIRD_PARTY_VERIFIER", +"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", +"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", +"TARGETING_TYPE_ENVIRONMENT", +"TARGETING_TYPE_CARRIER_AND_ISP", +"TARGETING_TYPE_OPERATING_SYSTEM", +"TARGETING_TYPE_DEVICE_MAKE_MODEL", +"TARGETING_TYPE_KEYWORD", +"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", +"TARGETING_TYPE_VIEWABILITY", +"TARGETING_TYPE_CATEGORY", +"TARGETING_TYPE_INVENTORY_SOURCE", +"TARGETING_TYPE_LANGUAGE", +"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", +"TARGETING_TYPE_GEO_REGION", +"TARGETING_TYPE_INVENTORY_SOURCE_GROUP", +"TARGETING_TYPE_EXCHANGE", +"TARGETING_TYPE_SUB_EXCHANGE", +"TARGETING_TYPE_POI", +"TARGETING_TYPE_BUSINESS_CHAIN", +"TARGETING_TYPE_CONTENT_DURATION", +"TARGETING_TYPE_CONTENT_STREAM_TYPE", +"TARGETING_TYPE_NATIVE_CONTENT_POSITION", +"TARGETING_TYPE_OMID", +"TARGETING_TYPE_AUDIO_CONTENT_TYPE", +"TARGETING_TYPE_CONTENT_GENRE", +"TARGETING_TYPE_YOUTUBE_VIDEO", +"TARGETING_TYPE_YOUTUBE_CHANNEL", +"TARGETING_TYPE_SESSION_POSITION", +"TARGETING_TYPE_CONTENT_THEME_EXCLUSION" +], +"enumDescriptions": [ +"Default value when type is not specified or is unknown in this version.", +"Target a channel (a custom group of related websites or apps).", +"Target an app category (for example, education or puzzle games).", +"Target a specific app (for example, Angry Birds).", +"Target a specific url (for example, quora.com).", +"Target ads during a chosen time period on a specific day.", +"Target ads to a specific age range (for example, 18-24).", +"Target ads to the specified regions on a regional location list.", +"Target ads to the specified points of interest on a proximity location list.", +"Target ads to a specific gender (for example, female or male).", +"Target a specific video player size for video ads.", +"Target user rewarded content for video ads.", +"Target ads to a specific parental status (for example, parent or not a parent).", +"Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", +"Target ads in a specific content outstream position.", +"Target ads to a specific device type (for example, tablet or connected TV).", +"Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", +"Target ads to specific web browsers (for example, Chrome).", +"Target ads to a specific household income range (for example, top 10%).", +"Target ads in a specific on screen position.", +"Filter web sites through third party verification (for example, IAS or DoubleVerify).", +"Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", +"Filter website content by sensitive categories (for example, adult).", +"Target ads to a specific environment (for example, web or app).", +"Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", +"Target ads to a specific operating system (for example, macOS).", +"Target ads to a specific device make or model (for example, Roku or Samsung).", +"Target ads to a specific keyword (for example, dog or retriever).", +"Target ads to a specific negative keyword list.", +"Target ads to a specific viewability (for example, 80% viewable).", +"Target ads to a specific content category (for example, arts & entertainment).", +"Purchase impressions from specific deals and auction packages.", +"Target ads to a specific language (for example, English or Japanese).", +"Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", +"Target ads to a specific regional location (for example, a city or state).", +"Purchase impressions from a group of deals and auction packages.", +"Purchase impressions from specific exchanges.", +"Purchase impressions from specific sub-exchanges.", +"Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", +"Target ads around locations of a business chain within a specific geo region.", +"Target ads to a specific video content duration.", +"Target ads to a specific video content stream type.", +"Target ads to a specific native content position.", +"Target ads in an Open Measurement enabled inventory.", +"Target ads to a specific audio content type.", +"Target ads to a specific content genre.", +"Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.", +"Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources." +], +"type": "string" +} +}, +"type": "object" +}, +"DemandGenBiddingStrategy": { +"description": "Settings that control the bid strategy for Demand Gen resources.", +"id": "DemandGenBiddingStrategy", +"properties": { +"effectiveBiddingValue": { +"description": "Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"effectiveBiddingValueSource": { +"description": "Output only. Source of the effective bidding value.", +"enum": [ +"BIDDING_SOURCE_UNSPECIFIED", +"BIDDING_SOURCE_LINE_ITEM", +"BIDDING_SOURCE_AD_GROUP" +], +"enumDescriptions": [ +"Bidding source is not specified or unknown.", +"Bidding value is inherited from the line item.", +"Bidding value is defined in the ad group." +], +"readOnly": true, +"type": "string" +}, +"type": { +"description": "Optional. The type of the bidding strategy. This can only be set at the line item level.", +"enum": [ +"DEMAND_GEN_BIDDING_STRATEGY_TYPE_UNSPECIFIED", +"DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA", +"DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS", +"DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSIONS", +"DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSION_VALUE", +"DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CLICKS" +], +"enumDescriptions": [ +"Type is not specified or unknown.", +"A bidding strategy that automatically optimizes conversions per dollar.", +"A bidding strategy that automatically maximizes revenue while averaging a specific target Return On Ad Spend (ROAS).", +"A bidding strategy that automatically maximizes number of conversions", +"A bidding strategy that automatically maximizes revenue while spending your budget.", +"A bidding strategy that automatically maximizes clicks within a given budget." +], +"type": "string" +}, +"value": { +"description": "Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"DemandGenCarouselAd": { +"description": "Details for a Demand Gen carousel ad.", +"id": "DemandGenCarouselAd", +"properties": { +"businessName": { +"description": "Required. The business name shown on the ad.", +"type": "string" +}, +"cards": { +"description": "Required. The list of cards shown on the ad.", +"items": { +"$ref": "CarouselCard" +}, +"type": "array" +}, +"customParameters": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The custom parameters to pass custom values to tracking URL template.", +"type": "object" +}, +"description": { +"description": "Required. The description of the ad.", +"type": "string" +}, +"finalUrl": { +"description": "Required. The URL address of the webpage that people reach after they click the ad.", +"type": "string" +}, +"finalUrlSuffix": { +"description": "Optional. The suffix to append to landing page URLs.", +"type": "string" +}, +"headline": { +"description": "Required. The headline of the ad.", +"type": "string" +}, +"logo": { +"$ref": "ImageAsset", +"description": "Required. The logo image used by this ad." +}, +"trackingUrl": { +"description": "Output only. The URL address loaded in the background for tracking purposes.", +"readOnly": true, +"type": "string" +}, +"userSpecifiedTrackingUrl": { +"description": "Optional. The tracking URL specified by the user manually.", +"type": "string" +} +}, +"type": "object" +}, +"DemandGenImageAd": { +"description": "Details for a Demand Gen image ad.", +"id": "DemandGenImageAd", +"properties": { +"businessName": { +"description": "Required. The business name shown on the ad.", +"type": "string" +}, +"callToAction": { +"description": "Required. The call-to-action button shown on the ad.", +"type": "string" +}, +"customParameters": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The custom parameters to pass custom values to tracking URL template.", +"type": "object" +}, +"descriptions": { +"description": "Required. The list of descriptions shown on the ad.", +"items": { +"type": "string" +}, +"type": "array" +}, +"finalMobileUrl": { +"description": "Optional. The URL address of the webpage that people reach after they click the ad on a mobile device.", +"type": "string" +}, +"finalUrl": { +"description": "Required. The URL address of the webpage that people reach after they click the ad.", +"type": "string" +}, +"finalUrlSuffix": { +"description": "Optional. The suffix to append to landing page URLs.", +"type": "string" +}, +"headlines": { +"description": "Required. The list of headlines shown on the ad.", +"items": { +"type": "string" +}, +"type": "array" +}, +"logoImages": { +"description": "The list of logo images shown on the ad.", +"items": { +"$ref": "ImageAsset" +}, +"type": "array" +}, +"marketingImages": { +"description": "The list of marketing images shown on the ad.", +"items": { +"$ref": "ImageAsset" +}, +"type": "array" +}, +"portraitMarketingImages": { +"description": "The list of portrait marketing images shown on the ad.", +"items": { +"$ref": "ImageAsset" +}, +"type": "array" +}, +"squareMarketingImages": { +"description": "The list of square marketing images shown on the ad.", +"items": { +"$ref": "ImageAsset" +}, +"type": "array" +}, +"trackingUrl": { +"description": "Output only. The URL address loaded in the background for tracking purposes.", +"readOnly": true, +"type": "string" +}, +"userSpecifiedTrackingUrl": { +"description": "Optional. The tracking URL specified by the user manually.", +"type": "string" +} +}, +"type": "object" +}, +"DemandGenProductAd": { +"description": "Details for a Demand Gen product ad.", +"id": "DemandGenProductAd", +"properties": { +"businessName": { +"description": "Required. The business name shown on the ad.", +"type": "string" +}, +"callToAction": { +"description": "Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE`", +"enum": [ +"CALL_TO_ACTION_UNSPECIFIED", +"AUTOMATED", +"LEARN_MORE", +"GET_QUOTE", +"APPLY_NOW", +"SIGN_UP", +"CONTACT_US", +"SUBSCRIBE", +"DOWNLOAD", +"BOOK_NOW", +"SHOP_NOW", +"BUY_NOW", +"DONATE_NOW", +"ORDER_NOW", +"PLAY_NOW", +"SEE_MORE", +"START_NOW", +"VISIT_SITE", +"WATCH_NOW" +], +"enumDescriptions": [ +"Not specified or unknown.", +"Automated.", +"Learn more.", +"Get quote.", +"Apply now.", +"Sign up.", +"Contact us.", +"Subscribe.", +"Download.", +"Book now.", +"Shop now.", +"Buy now.", +"Donate now.", +"Order now.", +"Play now.", +"See more.", +"Start now.", +"Visit site.", +"Watch now." +], +"type": "string" +}, +"customParameters": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The custom parameters to pass custom values to tracking URL template.", +"type": "object" +}, +"description": { +"description": "Required. The description of the ad.", +"type": "string" +}, +"displayUrlBreadcrumb1": { +"description": "Optional. The first piece after the domain in the display URL.", +"type": "string" +}, +"displayUrlBreadcrumb2": { +"description": "Optional. The second piece after the domain in the display URL.", +"type": "string" +}, +"finalUrl": { +"description": "Required. The URL address of the webpage that people reach after they click the ad.", +"type": "string" +}, +"finalUrlSuffix": { +"description": "Optional. The suffix to append to landing page URLs.", +"type": "string" +}, +"headline": { +"description": "Required. The headline of the ad.", +"type": "string" +}, +"logo": { +"$ref": "ImageAsset", +"description": "Required. The logo image used by this ad." +}, +"trackingUrl": { +"description": "Output only. The URL address loaded in the background for tracking purposes.", +"readOnly": true, +"type": "string" +}, +"userSpecifiedTrackingUrl": { +"description": "Optional. The tracking URL specified by the user manually.", +"type": "string" +} +}, +"type": "object" +}, +"DemandGenSettings": { +"description": "Settings for Demand Gen line items.", +"id": "DemandGenSettings", "properties": { -"dayOfWeek": { -"description": "Required. The day of the week for this day and time targeting setting.", -"enum": [ -"DAY_OF_WEEK_UNSPECIFIED", -"MONDAY", -"TUESDAY", -"WEDNESDAY", -"THURSDAY", -"FRIDAY", -"SATURDAY", -"SUNDAY" -], -"enumDescriptions": [ -"The day of the week is unspecified.", -"Monday", -"Tuesday", -"Wednesday", -"Thursday", -"Friday", -"Saturday", -"Sunday" -], +"geoLanguageTargetingEnabled": { +"description": "Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups.", +"type": "boolean" +}, +"linkedMerchantId": { +"description": "Optional. The ID of the merchant which is linked to the line item for product feed.", +"format": "int64", "type": "string" }, -"endHour": { -"description": "Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).", -"format": "int32", -"type": "integer" +"thirdPartyMeasurementConfigs": { +"$ref": "ThirdPartyMeasurementConfigs", +"description": "Optional. The third party measurement settings for the Demand Gen line item." +} }, -"startHour": { -"description": "Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).", -"format": "int32", -"type": "integer" +"type": "object" }, -"timeZoneResolution": { -"description": "Required. The mechanism used to determine which timezone to use for this day and time targeting setting.", +"DemandGenVideoAd": { +"description": "Details for a Demand Gen video ad.", +"id": "DemandGenVideoAd", +"properties": { +"businessName": { +"description": "Required. The business name shown on the ad.", +"type": "string" +}, +"callToAction": { +"description": "Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW`", "enum": [ -"TIME_ZONE_RESOLUTION_UNSPECIFIED", -"TIME_ZONE_RESOLUTION_END_USER", -"TIME_ZONE_RESOLUTION_ADVERTISER" +"CALL_TO_ACTION_UNSPECIFIED", +"AUTOMATED", +"LEARN_MORE", +"GET_QUOTE", +"APPLY_NOW", +"SIGN_UP", +"CONTACT_US", +"SUBSCRIBE", +"DOWNLOAD", +"BOOK_NOW", +"SHOP_NOW", +"BUY_NOW", +"DONATE_NOW", +"ORDER_NOW", +"PLAY_NOW", +"SEE_MORE", +"START_NOW", +"VISIT_SITE", +"WATCH_NOW" ], "enumDescriptions": [ -"Time zone resolution is either unspecific or unknown.", -"Times are resolved in the time zone of the user that saw the ad.", -"Times are resolved in the time zone of the advertiser that served the ad." +"Not specified or unknown.", +"Automated.", +"Learn more.", +"Get quote.", +"Apply now.", +"Sign up.", +"Contact us.", +"Subscribe.", +"Download.", +"Book now.", +"Shop now.", +"Buy now.", +"Donate now.", +"Order now.", +"Play now.", +"See more.", +"Start now.", +"Visit site.", +"Watch now." ], "type": "string" -} }, +"companionBanner": { +"$ref": "ImageAsset", +"description": "Optional. The companion banner used by this ad." +}, +"customParameters": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The custom parameters to pass custom values to tracking URL template.", "type": "object" }, -"DeleteAssignedTargetingOptionsRequest": { -"description": "A request listing which assigned targeting options of a given targeting type should be deleted.", -"id": "DeleteAssignedTargetingOptionsRequest", -"properties": { -"assignedTargetingOptionIds": { -"description": "Required. The assigned targeting option IDs to delete.", +"descriptions": { +"description": "Required. The list of descriptions shown on the ad.", "items": { "type": "string" }, "type": "array" }, -"targetingType": { -"description": "Required. Identifies the type of this assigned targeting option.", -"enum": [ -"TARGETING_TYPE_UNSPECIFIED", -"TARGETING_TYPE_CHANNEL", -"TARGETING_TYPE_APP_CATEGORY", -"TARGETING_TYPE_APP", -"TARGETING_TYPE_URL", -"TARGETING_TYPE_DAY_AND_TIME", -"TARGETING_TYPE_AGE_RANGE", -"TARGETING_TYPE_REGIONAL_LOCATION_LIST", -"TARGETING_TYPE_PROXIMITY_LOCATION_LIST", -"TARGETING_TYPE_GENDER", -"TARGETING_TYPE_VIDEO_PLAYER_SIZE", -"TARGETING_TYPE_USER_REWARDED_CONTENT", -"TARGETING_TYPE_PARENTAL_STATUS", -"TARGETING_TYPE_CONTENT_INSTREAM_POSITION", -"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", -"TARGETING_TYPE_DEVICE_TYPE", -"TARGETING_TYPE_AUDIENCE_GROUP", -"TARGETING_TYPE_BROWSER", -"TARGETING_TYPE_HOUSEHOLD_INCOME", -"TARGETING_TYPE_ON_SCREEN_POSITION", -"TARGETING_TYPE_THIRD_PARTY_VERIFIER", -"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", -"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", -"TARGETING_TYPE_ENVIRONMENT", -"TARGETING_TYPE_CARRIER_AND_ISP", -"TARGETING_TYPE_OPERATING_SYSTEM", -"TARGETING_TYPE_DEVICE_MAKE_MODEL", -"TARGETING_TYPE_KEYWORD", -"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", -"TARGETING_TYPE_VIEWABILITY", -"TARGETING_TYPE_CATEGORY", -"TARGETING_TYPE_INVENTORY_SOURCE", -"TARGETING_TYPE_LANGUAGE", -"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", -"TARGETING_TYPE_GEO_REGION", -"TARGETING_TYPE_INVENTORY_SOURCE_GROUP", -"TARGETING_TYPE_EXCHANGE", -"TARGETING_TYPE_SUB_EXCHANGE", -"TARGETING_TYPE_POI", -"TARGETING_TYPE_BUSINESS_CHAIN", -"TARGETING_TYPE_CONTENT_DURATION", -"TARGETING_TYPE_CONTENT_STREAM_TYPE", -"TARGETING_TYPE_NATIVE_CONTENT_POSITION", -"TARGETING_TYPE_OMID", -"TARGETING_TYPE_AUDIO_CONTENT_TYPE", -"TARGETING_TYPE_CONTENT_GENRE", -"TARGETING_TYPE_YOUTUBE_VIDEO", -"TARGETING_TYPE_YOUTUBE_CHANNEL", -"TARGETING_TYPE_SESSION_POSITION", -"TARGETING_TYPE_CONTENT_THEME_EXCLUSION" -], -"enumDescriptions": [ -"Default value when type is not specified or is unknown in this version.", -"Target a channel (a custom group of related websites or apps).", -"Target an app category (for example, education or puzzle games).", -"Target a specific app (for example, Angry Birds).", -"Target a specific url (for example, quora.com).", -"Target ads during a chosen time period on a specific day.", -"Target ads to a specific age range (for example, 18-24).", -"Target ads to the specified regions on a regional location list.", -"Target ads to the specified points of interest on a proximity location list.", -"Target ads to a specific gender (for example, female or male).", -"Target a specific video player size for video ads.", -"Target user rewarded content for video ads.", -"Target ads to a specific parental status (for example, parent or not a parent).", -"Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", -"Target ads in a specific content outstream position.", -"Target ads to a specific device type (for example, tablet or connected TV).", -"Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", -"Target ads to specific web browsers (for example, Chrome).", -"Target ads to a specific household income range (for example, top 10%).", -"Target ads in a specific on screen position.", -"Filter web sites through third party verification (for example, IAS or DoubleVerify).", -"Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", -"Filter website content by sensitive categories (for example, adult).", -"Target ads to a specific environment (for example, web or app).", -"Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", -"Target ads to a specific operating system (for example, macOS).", -"Target ads to a specific device make or model (for example, Roku or Samsung).", -"Target ads to a specific keyword (for example, dog or retriever).", -"Target ads to a specific negative keyword list.", -"Target ads to a specific viewability (for example, 80% viewable).", -"Target ads to a specific content category (for example, arts & entertainment).", -"Purchase impressions from specific deals and auction packages.", -"Target ads to a specific language (for example, English or Japanese).", -"Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", -"Target ads to a specific regional location (for example, a city or state).", -"Purchase impressions from a group of deals and auction packages.", -"Purchase impressions from specific exchanges.", -"Purchase impressions from specific sub-exchanges.", -"Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", -"Target ads around locations of a business chain within a specific geo region.", -"Target ads to a specific video content duration.", -"Target ads to a specific video content stream type.", -"Target ads to a specific native content position.", -"Target ads in an Open Measurement enabled inventory.", -"Target ads to a specific audio content type.", -"Target ads to a specific content genre.", -"Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", -"Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", -"Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.", -"Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources." -], +"displayUrlBreadcrumb1": { +"description": "Optional. The first piece after the domain in the display URL.", +"type": "string" +}, +"displayUrlBreadcrumb2": { +"description": "Optional. The second piece after the domain in the display URL.", +"type": "string" +}, +"finalMobileUrl": { +"description": "Optional. The URL address of the webpage that people reach after they click the ad on a mobile device.", +"type": "string" +}, +"finalUrl": { +"description": "Required. The URL address of the webpage that people reach after they click the ad.", +"type": "string" +}, +"finalUrlSuffix": { +"description": "Optional. The suffix to append to landing page URLs.", +"type": "string" +}, +"headlines": { +"description": "Required. The list of headlines shown on the ad.", +"items": { +"type": "string" +}, +"type": "array" +}, +"logo": { +"$ref": "ImageAsset", +"description": "Required. The logo image used by this ad." +}, +"longHeadlines": { +"description": "Required. The list of lone headlines shown on the ad.", +"items": { +"type": "string" +}, +"type": "array" +}, +"trackingUrl": { +"description": "Output only. The URL address loaded in the background for tracking purposes.", +"readOnly": true, +"type": "string" +}, +"userSpecifiedTrackingUrl": { +"description": "Optional. The tracking URL specified by the user manually.", "type": "string" +}, +"videos": { +"description": "Required. The list of YouTube video assets used by this ad.", +"items": { +"$ref": "YoutubeVideoDetails" +}, +"type": "array" } }, "type": "object" @@ -16966,6 +18111,11 @@ false "description": "Meta data of an image asset.", "id": "ImageAsset", "properties": { +"assetId": { +"description": "Required. The unique ID of the asset.", +"format": "int64", +"type": "string" +}, "fileSize": { "description": "Output only. File size of the image asset in bytes.", "format": "int64", @@ -17164,7 +18314,7 @@ false "Insertion order automation option is not specified or is unknown in this version.", "Automatic budget allocation. Allow the system to automatically shift budget to owning line items to optimize performance defined by kpi. No automation on bid settings.", "No automation of bid or budget on insertion order level. Bid and budget must be manually configured at the line item level.", -"Allow the system to automatically adjust bids and shift budget to owning line items to optimize performance defined by kpi." +"Allow the system to automatically adjust bids and shift budget to owning line items to optimize performance defined by bid_strategy." ], "type": "string" }, @@ -18094,6 +19244,13 @@ false "description": "Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`.", "id": "KeywordAssignedTargetingOptionDetails", "properties": { +"exemptedPolicyNames": { +"description": "Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted.", +"items": { +"type": "string" +}, +"type": "array" +}, "keyword": { "description": "Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.", "type": "string" @@ -18263,6 +19420,10 @@ false }, "type": "array" }, +"demandGenSettings": { +"$ref": "DemandGenSettings", +"description": "Optional. Settings specific to Demand Gen line items." +}, "displayName": { "description": "Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes.", "type": "string" @@ -18297,7 +19458,7 @@ false }, "frequencyCap": { "$ref": "FrequencyCap", -"description": "Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap." +"description": "Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN." }, "insertionOrderId": { "description": "Required. Immutable. The unique ID of the insertion order that the line item belongs to.", @@ -18338,7 +19499,8 @@ false "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_TARGET_FREQUENCY", "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIEW", "LINE_ITEM_TYPE_DISPLAY_OUT_OF_HOME", -"LINE_ITEM_TYPE_VIDEO_OUT_OF_HOME" +"LINE_ITEM_TYPE_VIDEO_OUT_OF_HOME", +"LINE_ITEM_TYPE_DEMAND_GEN" ], "enumDescriptions": [ "Type value is not specified or is unknown in this version. Line items of this type and their targeting cannot be created or updated using the API.", @@ -18362,7 +19524,8 @@ false "The goal of this line item type is to show the YouTube ads target number of times to the same person in a certain period of time. Line items of this type and their targeting cannot be created or updated using the API.", "YouTube video ads that aim to get more views with a variety of ad formats. Line items of this type and their targeting cannot be created or updated using the API.", "Display ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API.", -"Video ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API." +"Video ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API.", +"Demand Gen ads." ], "type": "string" }, @@ -18484,7 +19647,7 @@ false "id": "LineItemBudget", "properties": { "budgetAllocationType": { -"description": "Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order.", +"description": "Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types.", "enum": [ "LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNSPECIFIED", "LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC", @@ -20186,7 +21349,7 @@ false "type": "string" }, "markupType": { -"description": "Required. The markup type of the partner revenue model.", +"description": "Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`.", "enum": [ "PARTNER_REVENUE_MODEL_MARKUP_TYPE_UNSPECIFIED", "PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM", @@ -20857,9 +22020,9 @@ true, true, true, true, -false, -false, -false, +true, +true, +true, false, false, false @@ -20952,9 +22115,9 @@ true, true, true, true, -false, -false, -false, +true, +true, +true, false, false, false @@ -21036,6 +22199,37 @@ false }, "type": "object" }, +"SelectedInventories": { +"description": "The inventory control of the ad group.", +"id": "SelectedInventories", +"properties": { +"allowDiscover": { +"description": "Whether the ad group is opted-in to Discover inventory.", +"type": "boolean" +}, +"allowGmail": { +"description": "Whether the ad group is opted-in to Gmail inventory.", +"type": "boolean" +}, +"allowGoogleDisplayNetwork": { +"description": "Whether the ad group is opted-in to Google Display Network inventory.", +"type": "boolean" +}, +"allowYoutubeFeed": { +"description": "Whether the ad group is opted-in to YouTube in-feed inventory.", +"type": "boolean" +}, +"allowYoutubeShorts": { +"description": "Whether the ad group is opted-in to YouTube shorts inventory.", +"type": "boolean" +}, +"allowYoutubeStream": { +"description": "Whether the ad group is opted-in to YouTube in-stream.", +"type": "boolean" +} +}, +"type": "object" +}, "SensitiveCategoryAssignedTargetingOptionDetails": { "description": "Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`.", "id": "SensitiveCategoryAssignedTargetingOptionDetails", @@ -21582,28 +22776,28 @@ false "id": "ThirdPartyMeasurementConfigs", "properties": { "brandLiftVendorConfigs": { -"description": "Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_KANTAR_MILLWARD_BROWN` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL`", +"description": "Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL`", "items": { "$ref": "ThirdPartyVendorConfig" }, "type": "array" }, "brandSafetyVendorConfigs": { -"description": "Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_ZEFR`", +"description": "Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR`", "items": { "$ref": "ThirdPartyVendorConfig" }, "type": "array" }, "reachVendorConfigs": { -"description": "Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_KANTAR_MILLWARD_BROWN` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV`", +"description": "Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` * `THIRD_PARTY_VENDOR_GEMIUS`", "items": { "$ref": "ThirdPartyVendorConfig" }, "type": "array" }, "viewabilityVendorConfigs": { -"description": "Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL`", +"description": "Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS`", "items": { "$ref": "ThirdPartyVendorConfig" }, @@ -21696,7 +22890,16 @@ false "THIRD_PARTY_VENDOR_NIELSEN", "THIRD_PARTY_VENDOR_KANTAR", "THIRD_PARTY_VENDOR_DYNATA", -"THIRD_PARTY_VENDOR_TRANSUNION" +"THIRD_PARTY_VENDOR_TRANSUNION", +"THIRD_PARTY_VENDOR_ORIGIN", +"THIRD_PARTY_VENDOR_GEMIUS", +"THIRD_PARTY_VENDOR_MEDIA_SCOPE", +"THIRD_PARTY_VENDOR_AUDIENCE_PROJECT", +"THIRD_PARTY_VENDOR_VIDEO_AMP", +"THIRD_PARTY_VENDOR_ISPOT_TV", +"THIRD_PARTY_VENDOR_INTAGE", +"THIRD_PARTY_VENDOR_MACROMILL", +"THIRD_PARTY_VENDOR_VIDEO_RESEARCH" ], "enumDescriptions": [ "Unknown third-party vendor.", @@ -21710,7 +22913,16 @@ false "Nielsen.", "Kantar.", "Dynata.", -"Transunion." +"Transunion.", +"Origin.", +"Gemius.", +"MediaScope.", +"Audience Project.", +"Video Amp.", +"Ispot TV.", +"Intage.", +"Macromill.", +"Video Research." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v4.json b/googleapiclient/discovery_cache/documents/displayvideo.v4.json index ac7c9a2c61..6ca86cc5bb 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v4.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v4.json @@ -561,6 +561,70 @@ }, "adGroupAds": { "methods": { +"create": { +"description": "Creates an ad group ad.", +"flatPath": "v4/advertisers/{advertisersId}/adGroupAds", +"httpMethod": "POST", +"id": "displayvideo.advertisers.adGroupAds.create", +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "Output only. The unique ID of the advertiser the ad belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/adGroupAds", +"request": { +"$ref": "AdGroupAd" +}, +"response": { +"$ref": "AdGroupAd" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"delete": { +"description": "Deletes an ad group ad.", +"flatPath": "v4/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}", +"httpMethod": "DELETE", +"id": "displayvideo.advertisers.adGroupAds.delete", +"parameterOrder": [ +"advertiserId", +"adGroupAdId" +], +"parameters": { +"adGroupAdId": { +"description": "Required. The ID of the ad to delete.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"advertiserId": { +"description": "Required. The ID of the advertiser the ad belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/adGroupAds/{+adGroupAdId}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, "get": { "description": "Gets an ad group ad.", "flatPath": "v4/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}", @@ -642,11 +706,84 @@ "scopes": [ "https://www.googleapis.com/auth/display-video" ] +}, +"patch": { +"description": "Updates an ad group ad.", +"flatPath": "v4/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}", +"httpMethod": "PATCH", +"id": "displayvideo.advertisers.adGroupAds.patch", +"parameterOrder": [ +"advertiserId", +"adGroupAdId" +], +"parameters": { +"adGroupAdId": { +"description": "Output only. The unique ID of the ad. Assigned by the system.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"advertiserId": { +"description": "Output only. The unique ID of the advertiser the ad belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. The mask to control which fields to update.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/adGroupAds/{+adGroupAdId}", +"request": { +"$ref": "AdGroupAd" +}, +"response": { +"$ref": "AdGroupAd" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] } } }, "adGroups": { "methods": { +"bulkEditAssignedTargetingOptions": { +"description": "Bulk edits targeting options for multiple ad groups. The same set of delete and create requests will be applied to all specified ad groups. Specifically, the operation will delete the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.delete_requests from each ad group, and then create the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.create_requests. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.", +"flatPath": "v4/advertisers/{advertisersId}/adGroups:bulkEditAssignedTargetingOptions", +"httpMethod": "POST", +"id": "displayvideo.advertisers.adGroups.bulkEditAssignedTargetingOptions", +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the advertiser the ad groups belong to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/adGroups:bulkEditAssignedTargetingOptions", +"request": { +"$ref": "BulkEditAdGroupAssignedTargetingOptionsRequest" +}, +"response": { +"$ref": "BulkEditAdGroupAssignedTargetingOptionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, "bulkListAssignedTargetingOptions": { "description": "Lists assigned targeting options for multiple ad groups across targeting types. Inherited assigned targeting options are not included.", "flatPath": "v4/advertisers/{advertisersId}/adGroups:bulkListAssignedTargetingOptions", @@ -701,6 +838,70 @@ "https://www.googleapis.com/auth/display-video" ] }, +"create": { +"description": "Creates a new ad group. Returns the newly created ad group if successful.", +"flatPath": "v4/advertisers/{advertisersId}/adGroups", +"httpMethod": "POST", +"id": "displayvideo.advertisers.adGroups.create", +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "Output only. The unique ID of the advertiser the ad group belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/adGroups", +"request": { +"$ref": "AdGroup" +}, +"response": { +"$ref": "AdGroup" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"delete": { +"description": "Deletes a AdGroup. Returns error code `NOT_FOUND` if the ad group does not exist.", +"flatPath": "v4/advertisers/{advertisersId}/adGroups/{adGroupsId}", +"httpMethod": "DELETE", +"id": "displayvideo.advertisers.adGroups.delete", +"parameterOrder": [ +"advertiserId", +"adGroupId" +], +"parameters": { +"adGroupId": { +"description": "Required. The ID of the ad group to delete.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"advertiserId": { +"description": "Required. The ID of the advertiser this ad group belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, "get": { "description": "Gets an ad group.", "flatPath": "v4/advertisers/{advertisersId}/adGroups/{adGroupsId}", @@ -782,6 +983,50 @@ "scopes": [ "https://www.googleapis.com/auth/display-video" ] +}, +"patch": { +"description": "Updates an existing ad group. Returns the updated ad group if successful.", +"flatPath": "v4/advertisers/{advertisersId}/adGroups/{adGroupsId}", +"httpMethod": "PATCH", +"id": "displayvideo.advertisers.adGroups.patch", +"parameterOrder": [ +"advertiserId", +"adGroupId" +], +"parameters": { +"adGroupId": { +"description": "Output only. The unique ID of the ad group. Assigned by the system.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"advertiserId": { +"description": "Output only. The unique ID of the advertiser the ad group belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. The mask to control which fields to update.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}", +"request": { +"$ref": "AdGroup" +}, +"response": { +"$ref": "AdGroup" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] } }, "resources": { @@ -789,20 +1034,19 @@ "resources": { "assignedTargetingOptions": { "methods": { -"get": { -"description": "Gets a single targeting option assigned to an ad group. Inherited assigned targeting options are not included.", -"flatPath": "v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}", -"httpMethod": "GET", -"id": "displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.get", +"create": { +"description": "Assigns a targeting option to an ad group. Returns the assigned targeting option if successful. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.", +"flatPath": "v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions", +"httpMethod": "POST", +"id": "displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.create", "parameterOrder": [ "advertiserId", "adGroupId", -"targetingType", -"assignedTargetingOptionId" +"targetingType" ], "parameters": { "adGroupId": { -"description": "Required. The ID of the ad group the assigned targeting option belongs to.", +"description": "Required. The ID of the ad group the assigned targeting option will belong to.", "format": "int64", "location": "path", "pattern": "^[^/]+$", @@ -817,15 +1061,8 @@ "required": true, "type": "string" }, -"assignedTargetingOptionId": { -"description": "Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested.", -"location": "path", -"pattern": "^[^/]+$", -"required": true, -"type": "string" -}, "targetingType": { -"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`", +"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`", "enum": [ "TARGETING_TYPE_UNSPECIFIED", "TARGETING_TYPE_CHANNEL", @@ -936,7 +1173,10 @@ "type": "string" } }, -"path": "v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}", +"path": "v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions", +"request": { +"$ref": "AssignedTargetingOption" +}, "response": { "$ref": "AssignedTargetingOption" }, @@ -944,19 +1184,20 @@ "https://www.googleapis.com/auth/display-video" ] }, -"list": { -"description": "Lists the targeting options assigned to an ad group. Inherited assigned targeting options are not included.", -"flatPath": "v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions", -"httpMethod": "GET", -"id": "displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.list", +"delete": { +"description": "Deletes an assigned targeting option from an ad group. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.", +"flatPath": "v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}", +"httpMethod": "DELETE", +"id": "displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.delete", "parameterOrder": [ "advertiserId", "adGroupId", -"targetingType" +"targetingType", +"assignedTargetingOptionId" ], "parameters": { "adGroupId": { -"description": "Required. The ID of the ad group to list assigned targeting options for.", +"description": "Required. The ID of the ad group the assigned targeting option belongs to.", "format": "int64", "location": "path", "pattern": "^[^/]+$", @@ -971,29 +1212,15 @@ "required": true, "type": "string" }, -"filter": { -"description": "Optional. Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId=\"1\" OR assignedTargetingOptionId=\"2\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", -"location": "query", -"type": "string" -}, -"orderBy": { -"description": "Optional. Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `assignedTargetingOptionId desc`.", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "Optional. Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroupAssignedTargetingOptions` method. If not specified, the first page of results will be returned.", -"location": "query", +"assignedTargetingOptionId": { +"description": "Required. The ID of the assigned targeting option to delete.", +"location": "path", +"pattern": "^[^/]+$", +"required": true, "type": "string" }, "targetingType": { -"description": "Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`", +"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`", "enum": [ "TARGETING_TYPE_UNSPECIFIED", "TARGETING_TYPE_CHANNEL", @@ -1104,35 +1331,28 @@ "type": "string" } }, -"path": "v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions", +"path": "v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}", "response": { -"$ref": "ListAdGroupAssignedTargetingOptionsResponse" +"$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/display-video" ] -} -} -} -} }, -"youtubeAssetTypes": { -"resources": { -"youtubeAssetAssociations": { -"methods": { -"create": { -"description": "Creates a new association between the identified resource and a YouTube asset. Returns the newly-created association. *Warning:* This method is only available to an informed subset of users.", -"flatPath": "v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations", -"httpMethod": "POST", -"id": "displayvideo.advertisers.adGroups.youtubeAssetTypes.youtubeAssetAssociations.create", +"get": { +"description": "Gets a single targeting option assigned to an ad group. Inherited assigned targeting options are not included.", +"flatPath": "v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}", +"httpMethod": "GET", +"id": "displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.get", "parameterOrder": [ "advertiserId", "adGroupId", -"youtubeAssetType" +"targetingType", +"assignedTargetingOptionId" ], "parameters": { "adGroupId": { -"description": "The ID of an ad group.", +"description": "Required. The ID of the ad group the assigned targeting option belongs to.", "format": "int64", "location": "path", "pattern": "^[^/]+$", @@ -1140,32 +1360,125 @@ "type": "string" }, "advertiserId": { -"description": "Required. The ID of the advertiser that the linked entity belongs to.", +"description": "Required. The ID of the advertiser the ad group belongs to.", "format": "int64", "location": "path", "pattern": "^[^/]+$", "required": true, "type": "string" }, -"linkedEntity.lineItemId": { -"description": "The ID of a line item.", -"format": "int64", -"location": "query", +"assignedTargetingOptionId": { +"description": "Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested.", +"location": "path", +"pattern": "^[^/]+$", +"required": true, "type": "string" }, -"youtubeAssetType": { -"description": "Required. The type of YouTube asset associated with the resource.", +"targetingType": { +"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`", "enum": [ -"YOUTUBE_ASSET_TYPE_UNSPECIFIED", -"YOUTUBE_ASSET_TYPE_LOCATION", -"YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION", -"YOUTUBE_ASSET_TYPE_SITELINK" +"TARGETING_TYPE_UNSPECIFIED", +"TARGETING_TYPE_CHANNEL", +"TARGETING_TYPE_APP_CATEGORY", +"TARGETING_TYPE_APP", +"TARGETING_TYPE_URL", +"TARGETING_TYPE_DAY_AND_TIME", +"TARGETING_TYPE_AGE_RANGE", +"TARGETING_TYPE_REGIONAL_LOCATION_LIST", +"TARGETING_TYPE_PROXIMITY_LOCATION_LIST", +"TARGETING_TYPE_GENDER", +"TARGETING_TYPE_VIDEO_PLAYER_SIZE", +"TARGETING_TYPE_USER_REWARDED_CONTENT", +"TARGETING_TYPE_PARENTAL_STATUS", +"TARGETING_TYPE_CONTENT_INSTREAM_POSITION", +"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", +"TARGETING_TYPE_DEVICE_TYPE", +"TARGETING_TYPE_AUDIENCE_GROUP", +"TARGETING_TYPE_BROWSER", +"TARGETING_TYPE_HOUSEHOLD_INCOME", +"TARGETING_TYPE_ON_SCREEN_POSITION", +"TARGETING_TYPE_THIRD_PARTY_VERIFIER", +"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", +"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", +"TARGETING_TYPE_ENVIRONMENT", +"TARGETING_TYPE_CARRIER_AND_ISP", +"TARGETING_TYPE_OPERATING_SYSTEM", +"TARGETING_TYPE_DEVICE_MAKE_MODEL", +"TARGETING_TYPE_KEYWORD", +"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", +"TARGETING_TYPE_VIEWABILITY", +"TARGETING_TYPE_CATEGORY", +"TARGETING_TYPE_INVENTORY_SOURCE", +"TARGETING_TYPE_LANGUAGE", +"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", +"TARGETING_TYPE_GEO_REGION", +"TARGETING_TYPE_INVENTORY_SOURCE_GROUP", +"TARGETING_TYPE_EXCHANGE", +"TARGETING_TYPE_SUB_EXCHANGE", +"TARGETING_TYPE_POI", +"TARGETING_TYPE_BUSINESS_CHAIN", +"TARGETING_TYPE_CONTENT_DURATION", +"TARGETING_TYPE_CONTENT_STREAM_TYPE", +"TARGETING_TYPE_NATIVE_CONTENT_POSITION", +"TARGETING_TYPE_OMID", +"TARGETING_TYPE_AUDIO_CONTENT_TYPE", +"TARGETING_TYPE_CONTENT_GENRE", +"TARGETING_TYPE_YOUTUBE_VIDEO", +"TARGETING_TYPE_YOUTUBE_CHANNEL", +"TARGETING_TYPE_SESSION_POSITION", +"TARGETING_TYPE_CONTENT_THEME_EXCLUSION" ], "enumDescriptions": [ -"YouTube asset type is not specified or is unknown in this version.", -"Location asset.", -"Affiliate location asset.", -"Sitelink asset." +"Default value when type is not specified or is unknown in this version.", +"Target a channel (a custom group of related websites or apps).", +"Target an app category (for example, education or puzzle games).", +"Target a specific app (for example, Angry Birds).", +"Target a specific url (for example, quora.com).", +"Target ads during a chosen time period on a specific day.", +"Target ads to a specific age range (for example, 18-24).", +"Target ads to the specified regions on a regional location list.", +"Target ads to the specified points of interest on a proximity location list.", +"Target ads to a specific gender (for example, female or male).", +"Target a specific video player size for video ads.", +"Target user rewarded content for video ads.", +"Target ads to a specific parental status (for example, parent or not a parent).", +"Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", +"Target ads in a specific content outstream position.", +"Target ads to a specific device type (for example, tablet or connected TV).", +"Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", +"Target ads to specific web browsers (for example, Chrome).", +"Target ads to a specific household income range (for example, top 10%).", +"Target ads in a specific on screen position.", +"Filter web sites through third party verification (for example, IAS or DoubleVerify).", +"Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", +"Filter website content by sensitive categories (for example, adult).", +"Target ads to a specific environment (for example, web or app).", +"Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", +"Target ads to a specific operating system (for example, macOS).", +"Target ads to a specific device make or model (for example, Roku or Samsung).", +"Target ads to a specific keyword (for example, dog or retriever).", +"Target ads to a specific negative keyword list.", +"Target ads to a specific viewability (for example, 80% viewable).", +"Target ads to a specific content category (for example, arts & entertainment).", +"Purchase impressions from specific deals and auction packages.", +"Target ads to a specific language (for example, English or Japanese).", +"Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", +"Target ads to a specific regional location (for example, a city or state).", +"Purchase impressions from a group of deals and auction packages.", +"Purchase impressions from specific exchanges.", +"Purchase impressions from specific sub-exchanges.", +"Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", +"Target ads around locations of a business chain within a specific geo region.", +"Target ads to a specific video content duration.", +"Target ads to a specific video content stream type.", +"Target ads to a specific native content position.", +"Target ads in an Open Measurement enabled inventory.", +"Target ads to a specific audio content type.", +"Target ads to a specific content genre.", +"Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.", +"Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources." ], "location": "path", "pattern": "^[^/]+$", @@ -1173,31 +1486,27 @@ "type": "string" } }, -"path": "v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations", -"request": { -"$ref": "YoutubeAssetAssociation" -}, +"path": "v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}", "response": { -"$ref": "YoutubeAssetAssociation" +"$ref": "AssignedTargetingOption" }, "scopes": [ "https://www.googleapis.com/auth/display-video" ] }, -"delete": { -"description": "Deletes an existing association between the identified resource and a YouTube asset. *Warning:* This method is only available to an informed subset of users.", -"flatPath": "v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations/{youtubeAssetAssociationsId}", -"httpMethod": "DELETE", -"id": "displayvideo.advertisers.adGroups.youtubeAssetTypes.youtubeAssetAssociations.delete", +"list": { +"description": "Lists the targeting options assigned to an ad group. Inherited assigned targeting options are not included.", +"flatPath": "v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions", +"httpMethod": "GET", +"id": "displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.list", "parameterOrder": [ "advertiserId", "adGroupId", -"youtubeAssetType", -"youtubeAssetAssociationId" +"targetingType" ], "parameters": { "adGroupId": { -"description": "The ID of an ad group.", +"description": "Required. The ID of the ad group to list assigned targeting options for.", "format": "int64", "location": "path", "pattern": "^[^/]+$", @@ -1205,60 +1514,167 @@ "type": "string" }, "advertiserId": { -"description": "Required. The ID of the advertiser that the linked entity belongs to.", +"description": "Required. The ID of the advertiser the ad group belongs to.", "format": "int64", "location": "path", "pattern": "^[^/]+$", "required": true, "type": "string" }, -"linkedEntity.lineItemId": { -"description": "The ID of a line item.", -"format": "int64", +"filter": { +"description": "Optional. Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId=\"1\" OR assignedTargetingOptionId=\"2\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", "location": "query", "type": "string" }, -"youtubeAssetAssociationId": { -"description": "Required. The ID of the YouTube asset in the association. For `YOUTUBE_ASSET_TYPE_LOCATION` and `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION` associations: This should be the ID of the asset set linked, or 0 if the location_asset_filter or affiliate_location_asset_filter is `DISABLED`. For `YOUTUBE_ASSET_TYPE_SITELINK` associations: This should be the ID of the sitelink asset linked.", -"format": "int64", -"location": "path", -"pattern": "^[^/]+$", -"required": true, -"type": "string" -}, -"youtubeAssetType": { -"description": "Required. The type of YouTube asset associated with the resource.", -"enum": [ -"YOUTUBE_ASSET_TYPE_UNSPECIFIED", -"YOUTUBE_ASSET_TYPE_LOCATION", -"YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION", -"YOUTUBE_ASSET_TYPE_SITELINK" -], -"enumDescriptions": [ -"YouTube asset type is not specified or is unknown in this version.", -"Location asset.", -"Affiliate location asset.", -"Sitelink asset." -], -"location": "path", -"pattern": "^[^/]+$", -"required": true, +"orderBy": { +"description": "Optional. Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `assignedTargetingOptionId desc`.", +"location": "query", "type": "string" -} }, -"path": "v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations/{+youtubeAssetAssociationId}", -"response": { -"$ref": "Empty" +"pageSize": { +"description": "Optional. Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", +"format": "int32", +"location": "query", +"type": "integer" }, -"scopes": [ -"https://www.googleapis.com/auth/display-video" -] +"pageToken": { +"description": "Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroupAssignedTargetingOptions` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" }, -"list": { -"description": "Lists the YouTube asset associations linked to the given resource.", -"flatPath": "v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations", -"httpMethod": "GET", -"id": "displayvideo.advertisers.adGroups.youtubeAssetTypes.youtubeAssetAssociations.list", +"targetingType": { +"description": "Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`", +"enum": [ +"TARGETING_TYPE_UNSPECIFIED", +"TARGETING_TYPE_CHANNEL", +"TARGETING_TYPE_APP_CATEGORY", +"TARGETING_TYPE_APP", +"TARGETING_TYPE_URL", +"TARGETING_TYPE_DAY_AND_TIME", +"TARGETING_TYPE_AGE_RANGE", +"TARGETING_TYPE_REGIONAL_LOCATION_LIST", +"TARGETING_TYPE_PROXIMITY_LOCATION_LIST", +"TARGETING_TYPE_GENDER", +"TARGETING_TYPE_VIDEO_PLAYER_SIZE", +"TARGETING_TYPE_USER_REWARDED_CONTENT", +"TARGETING_TYPE_PARENTAL_STATUS", +"TARGETING_TYPE_CONTENT_INSTREAM_POSITION", +"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", +"TARGETING_TYPE_DEVICE_TYPE", +"TARGETING_TYPE_AUDIENCE_GROUP", +"TARGETING_TYPE_BROWSER", +"TARGETING_TYPE_HOUSEHOLD_INCOME", +"TARGETING_TYPE_ON_SCREEN_POSITION", +"TARGETING_TYPE_THIRD_PARTY_VERIFIER", +"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", +"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", +"TARGETING_TYPE_ENVIRONMENT", +"TARGETING_TYPE_CARRIER_AND_ISP", +"TARGETING_TYPE_OPERATING_SYSTEM", +"TARGETING_TYPE_DEVICE_MAKE_MODEL", +"TARGETING_TYPE_KEYWORD", +"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", +"TARGETING_TYPE_VIEWABILITY", +"TARGETING_TYPE_CATEGORY", +"TARGETING_TYPE_INVENTORY_SOURCE", +"TARGETING_TYPE_LANGUAGE", +"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", +"TARGETING_TYPE_GEO_REGION", +"TARGETING_TYPE_INVENTORY_SOURCE_GROUP", +"TARGETING_TYPE_EXCHANGE", +"TARGETING_TYPE_SUB_EXCHANGE", +"TARGETING_TYPE_POI", +"TARGETING_TYPE_BUSINESS_CHAIN", +"TARGETING_TYPE_CONTENT_DURATION", +"TARGETING_TYPE_CONTENT_STREAM_TYPE", +"TARGETING_TYPE_NATIVE_CONTENT_POSITION", +"TARGETING_TYPE_OMID", +"TARGETING_TYPE_AUDIO_CONTENT_TYPE", +"TARGETING_TYPE_CONTENT_GENRE", +"TARGETING_TYPE_YOUTUBE_VIDEO", +"TARGETING_TYPE_YOUTUBE_CHANNEL", +"TARGETING_TYPE_SESSION_POSITION", +"TARGETING_TYPE_CONTENT_THEME_EXCLUSION" +], +"enumDescriptions": [ +"Default value when type is not specified or is unknown in this version.", +"Target a channel (a custom group of related websites or apps).", +"Target an app category (for example, education or puzzle games).", +"Target a specific app (for example, Angry Birds).", +"Target a specific url (for example, quora.com).", +"Target ads during a chosen time period on a specific day.", +"Target ads to a specific age range (for example, 18-24).", +"Target ads to the specified regions on a regional location list.", +"Target ads to the specified points of interest on a proximity location list.", +"Target ads to a specific gender (for example, female or male).", +"Target a specific video player size for video ads.", +"Target user rewarded content for video ads.", +"Target ads to a specific parental status (for example, parent or not a parent).", +"Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", +"Target ads in a specific content outstream position.", +"Target ads to a specific device type (for example, tablet or connected TV).", +"Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", +"Target ads to specific web browsers (for example, Chrome).", +"Target ads to a specific household income range (for example, top 10%).", +"Target ads in a specific on screen position.", +"Filter web sites through third party verification (for example, IAS or DoubleVerify).", +"Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", +"Filter website content by sensitive categories (for example, adult).", +"Target ads to a specific environment (for example, web or app).", +"Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", +"Target ads to a specific operating system (for example, macOS).", +"Target ads to a specific device make or model (for example, Roku or Samsung).", +"Target ads to a specific keyword (for example, dog or retriever).", +"Target ads to a specific negative keyword list.", +"Target ads to a specific viewability (for example, 80% viewable).", +"Target ads to a specific content category (for example, arts & entertainment).", +"Purchase impressions from specific deals and auction packages.", +"Target ads to a specific language (for example, English or Japanese).", +"Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", +"Target ads to a specific regional location (for example, a city or state).", +"Purchase impressions from a group of deals and auction packages.", +"Purchase impressions from specific exchanges.", +"Purchase impressions from specific sub-exchanges.", +"Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", +"Target ads around locations of a business chain within a specific geo region.", +"Target ads to a specific video content duration.", +"Target ads to a specific video content stream type.", +"Target ads to a specific native content position.", +"Target ads in an Open Measurement enabled inventory.", +"Target ads to a specific audio content type.", +"Target ads to a specific content genre.", +"Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.", +"Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources." +], +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions", +"response": { +"$ref": "ListAdGroupAssignedTargetingOptionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +} +} +} +} +}, +"youtubeAssetTypes": { +"resources": { +"youtubeAssetAssociations": { +"methods": { +"create": { +"description": "Creates a new association between the identified resource and a YouTube asset. Returns the newly-created association. *Warning:* This method is only available to an informed subset of users.", +"flatPath": "v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations", +"httpMethod": "POST", +"id": "displayvideo.advertisers.adGroups.youtubeAssetTypes.youtubeAssetAssociations.create", "parameterOrder": [ "advertiserId", "adGroupId", @@ -1287,24 +1703,8 @@ "location": "query", "type": "string" }, -"orderBy": { -"description": "Optional. Field by which to sort the list. The only acceptable values are: * `linkedYoutubeAsset.locationAssetFilter.assetSetId`, * `linkedYoutubeAsset.affiliateLocationAssetFilter.assetSetId`, * `linkedYoutubeAsset.sitelinkAsset.assetId` The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be added to the field name. Example: `linkedYoutubeAsset.sitelinkAsset.assetId desc`.", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "Optional. Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListYoutubeAssetAssociations` method. If not specified, the first page of results will be returned.", -"location": "query", -"type": "string" -}, "youtubeAssetType": { -"description": "Required. The type of YouTube asset being associated with the resource.", +"description": "Required. The type of YouTube asset associated with the resource.", "enum": [ "YOUTUBE_ASSET_TYPE_UNSPECIFIED", "YOUTUBE_ASSET_TYPE_LOCATION", @@ -1324,115 +1724,265 @@ } }, "path": "v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations", +"request": { +"$ref": "YoutubeAssetAssociation" +}, "response": { -"$ref": "ListYoutubeAssetAssociationsResponse" +"$ref": "YoutubeAssetAssociation" }, "scopes": [ "https://www.googleapis.com/auth/display-video" ] -} -} -} -} -} -} -}, -"assets": { -"methods": { -"upload": { -"description": "Uploads an asset. Returns the ID of the newly uploaded asset if successful. The asset file size should be no more than 10 MB for images, 200 MB for ZIP files, and 1 GB for videos. Must be used within the [multipart media upload process](/display-video/api/guides/how-tos/upload#multipart). Examples using provided client libraries can be found in our [Creating Creatives guide](/display-video/api/guides/creating-creatives/overview#upload_an_asset).", -"flatPath": "v4/advertisers/{advertisersId}/assets", -"httpMethod": "POST", -"id": "displayvideo.advertisers.assets.upload", -"mediaUpload": { -"accept": [ -"*/*" -], -"protocols": { -"simple": { -"multipart": true, -"path": "/upload/v4/advertisers/{+advertiserId}/assets" -} -} }, +"delete": { +"description": "Deletes an existing association between the identified resource and a YouTube asset. *Warning:* This method is only available to an informed subset of users.", +"flatPath": "v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations/{youtubeAssetAssociationsId}", +"httpMethod": "DELETE", +"id": "displayvideo.advertisers.adGroups.youtubeAssetTypes.youtubeAssetAssociations.delete", "parameterOrder": [ -"advertiserId" +"advertiserId", +"adGroupId", +"youtubeAssetType", +"youtubeAssetAssociationId" ], "parameters": { -"advertiserId": { -"description": "Required. The ID of the advertiser this asset belongs to.", +"adGroupId": { +"description": "The ID of an ad group.", "format": "int64", "location": "path", "pattern": "^[^/]+$", "required": true, "type": "string" -} -}, -"path": "v4/advertisers/{+advertiserId}/assets", -"request": { -"$ref": "CreateAssetRequest" -}, -"response": { -"$ref": "CreateAssetResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/display-video" -], -"supportsMediaUpload": true -} -} }, -"campaigns": { -"methods": { -"create": { -"description": "Creates a new campaign. Returns the newly created campaign if successful.", -"flatPath": "v4/advertisers/{advertisersId}/campaigns", -"httpMethod": "POST", -"id": "displayvideo.advertisers.campaigns.create", -"parameterOrder": [ -"advertiserId" -], -"parameters": { "advertiserId": { -"description": "Output only. The unique ID of the advertiser the campaign belongs to.", +"description": "Required. The ID of the advertiser that the linked entity belongs to.", "format": "int64", "location": "path", "pattern": "^[^/]+$", "required": true, "type": "string" -} -}, -"path": "v4/advertisers/{+advertiserId}/campaigns", -"request": { -"$ref": "Campaign" -}, -"response": { -"$ref": "Campaign" }, -"scopes": [ -"https://www.googleapis.com/auth/display-video", -"https://www.googleapis.com/auth/display-video-mediaplanning" -] +"linkedEntity.lineItemId": { +"description": "The ID of a line item.", +"format": "int64", +"location": "query", +"type": "string" }, -"delete": { -"description": "Permanently deletes a campaign. A deleted campaign cannot be recovered. The campaign should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.", -"flatPath": "v4/advertisers/{advertisersId}/campaigns/{campaignsId}", -"httpMethod": "DELETE", -"id": "displayvideo.advertisers.campaigns.delete", -"parameterOrder": [ -"advertiserId", -"campaignId" -], -"parameters": { -"advertiserId": { -"description": "The ID of the advertiser this campaign belongs to.", +"youtubeAssetAssociationId": { +"description": "Required. The ID of the YouTube asset in the association. For `YOUTUBE_ASSET_TYPE_LOCATION` and `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION` associations: This should be the ID of the asset set linked, or 0 if the location_asset_filter or affiliate_location_asset_filter is `DISABLED`. For `YOUTUBE_ASSET_TYPE_SITELINK` associations: This should be the ID of the sitelink asset linked.", "format": "int64", "location": "path", "pattern": "^[^/]+$", "required": true, "type": "string" }, -"campaignId": { +"youtubeAssetType": { +"description": "Required. The type of YouTube asset associated with the resource.", +"enum": [ +"YOUTUBE_ASSET_TYPE_UNSPECIFIED", +"YOUTUBE_ASSET_TYPE_LOCATION", +"YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION", +"YOUTUBE_ASSET_TYPE_SITELINK" +], +"enumDescriptions": [ +"YouTube asset type is not specified or is unknown in this version.", +"Location asset.", +"Affiliate location asset.", +"Sitelink asset." +], +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations/{+youtubeAssetAssociationId}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"list": { +"description": "Lists the YouTube asset associations linked to the given resource.", +"flatPath": "v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations", +"httpMethod": "GET", +"id": "displayvideo.advertisers.adGroups.youtubeAssetTypes.youtubeAssetAssociations.list", +"parameterOrder": [ +"advertiserId", +"adGroupId", +"youtubeAssetType" +], +"parameters": { +"adGroupId": { +"description": "The ID of an ad group.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"advertiserId": { +"description": "Required. The ID of the advertiser that the linked entity belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"linkedEntity.lineItemId": { +"description": "The ID of a line item.", +"format": "int64", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Field by which to sort the list. The only acceptable values are: * `linkedYoutubeAsset.locationAssetFilter.assetSetId`, * `linkedYoutubeAsset.affiliateLocationAssetFilter.assetSetId`, * `linkedYoutubeAsset.sitelinkAsset.assetId` The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be added to the field name. Example: `linkedYoutubeAsset.sitelinkAsset.assetId desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListYoutubeAssetAssociations` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +}, +"youtubeAssetType": { +"description": "Required. The type of YouTube asset being associated with the resource.", +"enum": [ +"YOUTUBE_ASSET_TYPE_UNSPECIFIED", +"YOUTUBE_ASSET_TYPE_LOCATION", +"YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION", +"YOUTUBE_ASSET_TYPE_SITELINK" +], +"enumDescriptions": [ +"YouTube asset type is not specified or is unknown in this version.", +"Location asset.", +"Affiliate location asset.", +"Sitelink asset." +], +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations", +"response": { +"$ref": "ListYoutubeAssetAssociationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +} +} +} +} +} +} +}, +"assets": { +"methods": { +"upload": { +"description": "Uploads an asset. Returns the ID of the newly uploaded asset if successful. The asset file size should be no more than 10 MB for images, 200 MB for ZIP files, and 1 GB for videos. Must be used within the [multipart media upload process](/display-video/api/guides/how-tos/upload#multipart). Examples using provided client libraries can be found in our [Creating Creatives guide](/display-video/api/guides/creating-creatives/overview#upload_an_asset).", +"flatPath": "v4/advertisers/{advertisersId}/assets", +"httpMethod": "POST", +"id": "displayvideo.advertisers.assets.upload", +"mediaUpload": { +"accept": [ +"*/*" +], +"protocols": { +"simple": { +"multipart": true, +"path": "/upload/v4/advertisers/{+advertiserId}/assets" +} +} +}, +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the advertiser this asset belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/assets", +"request": { +"$ref": "CreateAssetRequest" +}, +"response": { +"$ref": "CreateAssetResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +], +"supportsMediaUpload": true +} +} +}, +"campaigns": { +"methods": { +"create": { +"description": "Creates a new campaign. Returns the newly created campaign if successful.", +"flatPath": "v4/advertisers/{advertisersId}/campaigns", +"httpMethod": "POST", +"id": "displayvideo.advertisers.campaigns.create", +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "Output only. The unique ID of the advertiser the campaign belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/campaigns", +"request": { +"$ref": "Campaign" +}, +"response": { +"$ref": "Campaign" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video", +"https://www.googleapis.com/auth/display-video-mediaplanning" +] +}, +"delete": { +"description": "Permanently deletes a campaign. A deleted campaign cannot be recovered. The campaign should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.", +"flatPath": "v4/advertisers/{advertisersId}/campaigns/{campaignsId}", +"httpMethod": "DELETE", +"id": "displayvideo.advertisers.campaigns.delete", +"parameterOrder": [ +"advertiserId", +"campaignId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser this campaign belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"campaignId": { "description": "The ID of the campaign we need to delete.", "format": "int64", "location": "path", @@ -8813,7 +9363,7 @@ } } }, -"revision": "20260224", +"revision": "20260305", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActiveViewVideoViewabilityMetricConfig": { @@ -9002,7 +9552,8 @@ "AD_GROUP_FORMAT_AUDIO", "AD_GROUP_FORMAT_RESPONSIVE", "AD_GROUP_FORMAT_REACH", -"AD_GROUP_FORMAT_MASTHEAD" +"AD_GROUP_FORMAT_MASTHEAD", +"AD_GROUP_FORMAT_DEMAND_GEN" ], "enumDescriptions": [ "Format value is not specified or is unknown in this version.", @@ -9013,7 +9564,8 @@ "Non-skippable in-stream audio ads.", "Responsive ads.", "[Effective reach ad groups] (https://support.google.com/displayvideo/answer/9173684), including in-stream and bumper ads.", -"Masthead Ad that is surfaced on the top slot on the YouTube homepage." +"Masthead Ad that is surfaced on the top slot on the YouTube homepage.", +"Demand Gen ads." ], "type": "string" }, @@ -9023,6 +9575,10 @@ "readOnly": true, "type": "string" }, +"adGroupInventoryControl": { +"$ref": "AdGroupInventoryControl", +"description": "Optional. Specifies the inventory control of the ad group. This field is required for Demand Gen ad groups." +}, "advertiserId": { "description": "Output only. The unique ID of the advertiser the ad group belongs to.", "format": "int64", @@ -9122,6 +9678,22 @@ "description": "Output only. Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach.", "readOnly": true }, +"demandGenCarouselAd": { +"$ref": "DemandGenCarouselAd", +"description": "Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd)." +}, +"demandGenImageAd": { +"$ref": "DemandGenImageAd", +"description": "Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd)." +}, +"demandGenProductAd": { +"$ref": "DemandGenProductAd", +"description": "Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd)." +}, +"demandGenVideoAd": { +"$ref": "DemandGenVideoAd", +"description": "Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd)." +}, "displayName": { "description": "Required. The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes.", "type": "string" @@ -9200,6 +9772,31 @@ }, "type": "object" }, +"AdGroupInventoryControl": { +"description": "The inventory control of the ad group.", +"id": "AdGroupInventoryControl", +"properties": { +"adGroupInventoryStrategy": { +"description": "The inventory strategy.", +"enum": [ +"AD_GROUP_INVENTORY_STRATEGY_UNSPECIFIED", +"AD_GROUP_INVENTORY_STRATEGY_ALL_GOOGLE_AND_DISPLAY_NETWORK_INVENTORY", +"AD_GROUP_INVENTORY_STRATEGY_ALL_GOOGLE_INVENTORY" +], +"enumDescriptions": [ +"Not specified or unknown.", +"The ad group is opted-in to all Google and Display Network inventory.", +"The ad group is opted-in to all Google inventory." +], +"type": "string" +}, +"selectedInventories": { +"$ref": "SelectedInventories", +"description": "The selected inventories." +} +}, +"type": "object" +}, "AdPolicy": { "description": "A single ad policy associated with an ad group ad.", "id": "AdPolicy", @@ -11863,6 +12460,10 @@ "description": "Settings that control the bid strategy. Bid strategy determines the bid price.", "id": "BiddingStrategy", "properties": { +"demandGenBid": { +"$ref": "DemandGenBiddingStrategy", +"description": "A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity." +}, "fixedBid": { "$ref": "FixedBidStrategy", "description": "A strategy that uses a fixed bid price." @@ -11972,19 +12573,27 @@ }, "type": "object" }, -"BulkEditAdvertiserAssignedTargetingOptionsRequest": { -"description": "Request message for BulkEditAdvertiserAssignedTargetingOptions.", -"id": "BulkEditAdvertiserAssignedTargetingOptionsRequest", +"BulkEditAdGroupAssignedTargetingOptionsRequest": { +"description": "Request message for BulkEditAdGroupAssignedTargetingOptions.", +"id": "BulkEditAdGroupAssignedTargetingOptionsRequest", "properties": { +"adGroupIds": { +"description": "Required. The IDs of the ad groups the assigned targeting options will belong to. A maximum of 25 ad group IDs can be specified.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +}, "createRequests": { -"description": "The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_INVENTORY_MODE`", +"description": "Optional. The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionRequest`. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`", "items": { "$ref": "CreateAssignedTargetingOptionsRequest" }, "type": "array" }, "deleteRequests": { -"description": "The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_INVENTORY_MODE`", +"description": "Optional. The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`", "items": { "$ref": "DeleteAssignedTargetingOptionsRequest" }, @@ -11993,29 +12602,83 @@ }, "type": "object" }, -"BulkEditAdvertiserAssignedTargetingOptionsResponse": { -"id": "BulkEditAdvertiserAssignedTargetingOptionsResponse", +"BulkEditAdGroupAssignedTargetingOptionsResponse": { +"description": "Response message for BulkEditAssignedTargetingOptions.", +"id": "BulkEditAdGroupAssignedTargetingOptionsResponse", "properties": { -"createdAssignedTargetingOptions": { -"description": "The list of assigned targeting options that have been successfully created. This list will be absent if empty.", +"errors": { +"description": "Output only. The error information for each ad group that failed to update.", "items": { -"$ref": "AssignedTargetingOption" +"$ref": "Status" }, +"readOnly": true, "type": "array" -} -}, -"type": "object" }, -"BulkEditAssignedInventorySourcesRequest": { -"description": "Request message for AssignedInventorySourceService.BulkEdit.", -"id": "BulkEditAssignedInventorySourcesRequest", -"properties": { -"advertiserId": { -"description": "The ID of the advertiser that owns the parent inventory source group. The parent partner does not have access to these assigned inventory sources.", +"failedAdGroupIds": { +"description": "Output only. The IDs of the ad groups which failed to update.", +"items": { "format": "int64", "type": "string" }, -"createdAssignedInventorySources": { +"readOnly": true, +"type": "array" +}, +"updatedAdGroupIds": { +"description": "Output only. The IDs of the ad groups which were successfully updated.", +"items": { +"format": "int64", +"type": "string" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"BulkEditAdvertiserAssignedTargetingOptionsRequest": { +"description": "Request message for BulkEditAdvertiserAssignedTargetingOptions.", +"id": "BulkEditAdvertiserAssignedTargetingOptionsRequest", +"properties": { +"createRequests": { +"description": "The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_INVENTORY_MODE`", +"items": { +"$ref": "CreateAssignedTargetingOptionsRequest" +}, +"type": "array" +}, +"deleteRequests": { +"description": "The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_INVENTORY_MODE`", +"items": { +"$ref": "DeleteAssignedTargetingOptionsRequest" +}, +"type": "array" +} +}, +"type": "object" +}, +"BulkEditAdvertiserAssignedTargetingOptionsResponse": { +"id": "BulkEditAdvertiserAssignedTargetingOptionsResponse", +"properties": { +"createdAssignedTargetingOptions": { +"description": "The list of assigned targeting options that have been successfully created. This list will be absent if empty.", +"items": { +"$ref": "AssignedTargetingOption" +}, +"type": "array" +} +}, +"type": "object" +}, +"BulkEditAssignedInventorySourcesRequest": { +"description": "Request message for AssignedInventorySourceService.BulkEdit.", +"id": "BulkEditAssignedInventorySourcesRequest", +"properties": { +"advertiserId": { +"description": "The ID of the advertiser that owns the parent inventory source group. The parent partner does not have access to these assigned inventory sources.", +"format": "int64", +"type": "string" +}, +"createdAssignedInventorySources": { "description": "The assigned inventory sources to create in bulk, specified as a list of AssignedInventorySources.", "items": { "$ref": "AssignedInventorySource" @@ -12754,6 +13417,41 @@ }, "type": "object" }, +"CarouselCard": { +"description": "Details for a Demand Gen carousel card.", +"id": "CarouselCard", +"properties": { +"callToAction": { +"description": "Required. The call-to-action button shown on the card. Must use 10 characters or less.", +"type": "string" +}, +"finalMobileUrl": { +"description": "Optional. The URL address of the webpage that people reach after they click the card on a mobile device.", +"type": "string" +}, +"finalUrl": { +"description": "Required. The URL address of the webpage that people reach after they click the card.", +"type": "string" +}, +"headline": { +"description": "Required. The headline of the card.", +"type": "string" +}, +"marketingImage": { +"$ref": "ImageAsset", +"description": "Optional. The marketing image shown on the card." +}, +"portraitMarketingImage": { +"$ref": "ImageAsset", +"description": "Optional. The portrait marketing image shown on the card." +}, +"squareMarketingImage": { +"$ref": "ImageAsset", +"description": "Optional. The square marketing image shown on the card." +} +}, +"type": "object" +}, "CarrierAndIspAssignedTargetingOptionDetails": { "description": "Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.", "id": "CarrierAndIspAssignedTargetingOptionDetails", @@ -13545,6 +14243,11 @@ "description": "The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000.", "format": "int64", "type": "string" +}, +"primaryAttributionModelId": { +"description": "Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items.", +"format": "int64", +"type": "string" } }, "type": "object" @@ -13782,9 +14485,9 @@ true, true, true, true, -false, -false, -false, +true, +true, +true, false, false, false @@ -14710,179 +15413,621 @@ false }, "type": "object" }, -"DayAndTimeAssignedTargetingOptionDetails": { -"description": "Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`.", -"id": "DayAndTimeAssignedTargetingOptionDetails", +"DayAndTimeAssignedTargetingOptionDetails": { +"description": "Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`.", +"id": "DayAndTimeAssignedTargetingOptionDetails", +"properties": { +"dayOfWeek": { +"description": "Required. The day of the week for this day and time targeting setting.", +"enum": [ +"DAY_OF_WEEK_UNSPECIFIED", +"MONDAY", +"TUESDAY", +"WEDNESDAY", +"THURSDAY", +"FRIDAY", +"SATURDAY", +"SUNDAY" +], +"enumDescriptions": [ +"The day of the week is unspecified.", +"Monday", +"Tuesday", +"Wednesday", +"Thursday", +"Friday", +"Saturday", +"Sunday" +], +"type": "string" +}, +"endHour": { +"description": "Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).", +"format": "int32", +"type": "integer" +}, +"startHour": { +"description": "Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).", +"format": "int32", +"type": "integer" +}, +"timeZoneResolution": { +"description": "Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER.", +"enum": [ +"TIME_ZONE_RESOLUTION_UNSPECIFIED", +"TIME_ZONE_RESOLUTION_END_USER", +"TIME_ZONE_RESOLUTION_ADVERTISER" +], +"enumDescriptions": [ +"Time zone resolution is either unspecific or unknown.", +"Times are resolved in the time zone of the user that saw the ad.", +"Times are resolved in the time zone of the advertiser that served the ad." +], +"type": "string" +} +}, +"type": "object" +}, +"DeleteAssignedTargetingOptionsRequest": { +"description": "A request listing which assigned targeting options of a given targeting type should be deleted.", +"id": "DeleteAssignedTargetingOptionsRequest", +"properties": { +"assignedTargetingOptionIds": { +"description": "Required. The assigned targeting option IDs to delete.", +"items": { +"type": "string" +}, +"type": "array" +}, +"targetingType": { +"description": "Required. Identifies the type of this assigned targeting option.", +"enum": [ +"TARGETING_TYPE_UNSPECIFIED", +"TARGETING_TYPE_CHANNEL", +"TARGETING_TYPE_APP_CATEGORY", +"TARGETING_TYPE_APP", +"TARGETING_TYPE_URL", +"TARGETING_TYPE_DAY_AND_TIME", +"TARGETING_TYPE_AGE_RANGE", +"TARGETING_TYPE_REGIONAL_LOCATION_LIST", +"TARGETING_TYPE_PROXIMITY_LOCATION_LIST", +"TARGETING_TYPE_GENDER", +"TARGETING_TYPE_VIDEO_PLAYER_SIZE", +"TARGETING_TYPE_USER_REWARDED_CONTENT", +"TARGETING_TYPE_PARENTAL_STATUS", +"TARGETING_TYPE_CONTENT_INSTREAM_POSITION", +"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", +"TARGETING_TYPE_DEVICE_TYPE", +"TARGETING_TYPE_AUDIENCE_GROUP", +"TARGETING_TYPE_BROWSER", +"TARGETING_TYPE_HOUSEHOLD_INCOME", +"TARGETING_TYPE_ON_SCREEN_POSITION", +"TARGETING_TYPE_THIRD_PARTY_VERIFIER", +"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", +"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", +"TARGETING_TYPE_ENVIRONMENT", +"TARGETING_TYPE_CARRIER_AND_ISP", +"TARGETING_TYPE_OPERATING_SYSTEM", +"TARGETING_TYPE_DEVICE_MAKE_MODEL", +"TARGETING_TYPE_KEYWORD", +"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", +"TARGETING_TYPE_VIEWABILITY", +"TARGETING_TYPE_CATEGORY", +"TARGETING_TYPE_INVENTORY_SOURCE", +"TARGETING_TYPE_LANGUAGE", +"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", +"TARGETING_TYPE_GEO_REGION", +"TARGETING_TYPE_INVENTORY_SOURCE_GROUP", +"TARGETING_TYPE_EXCHANGE", +"TARGETING_TYPE_SUB_EXCHANGE", +"TARGETING_TYPE_POI", +"TARGETING_TYPE_BUSINESS_CHAIN", +"TARGETING_TYPE_CONTENT_DURATION", +"TARGETING_TYPE_CONTENT_STREAM_TYPE", +"TARGETING_TYPE_NATIVE_CONTENT_POSITION", +"TARGETING_TYPE_OMID", +"TARGETING_TYPE_AUDIO_CONTENT_TYPE", +"TARGETING_TYPE_CONTENT_GENRE", +"TARGETING_TYPE_YOUTUBE_VIDEO", +"TARGETING_TYPE_YOUTUBE_CHANNEL", +"TARGETING_TYPE_SESSION_POSITION", +"TARGETING_TYPE_CONTENT_THEME_EXCLUSION" +], +"enumDescriptions": [ +"Default value when type is not specified or is unknown in this version.", +"Target a channel (a custom group of related websites or apps).", +"Target an app category (for example, education or puzzle games).", +"Target a specific app (for example, Angry Birds).", +"Target a specific url (for example, quora.com).", +"Target ads during a chosen time period on a specific day.", +"Target ads to a specific age range (for example, 18-24).", +"Target ads to the specified regions on a regional location list.", +"Target ads to the specified points of interest on a proximity location list.", +"Target ads to a specific gender (for example, female or male).", +"Target a specific video player size for video ads.", +"Target user rewarded content for video ads.", +"Target ads to a specific parental status (for example, parent or not a parent).", +"Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", +"Target ads in a specific content outstream position.", +"Target ads to a specific device type (for example, tablet or connected TV).", +"Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", +"Target ads to specific web browsers (for example, Chrome).", +"Target ads to a specific household income range (for example, top 10%).", +"Target ads in a specific on screen position.", +"Filter web sites through third party verification (for example, IAS or DoubleVerify).", +"Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", +"Filter website content by sensitive categories (for example, adult).", +"Target ads to a specific environment (for example, web or app).", +"Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", +"Target ads to a specific operating system (for example, macOS).", +"Target ads to a specific device make or model (for example, Roku or Samsung).", +"Target ads to a specific keyword (for example, dog or retriever).", +"Target ads to a specific negative keyword list.", +"Target ads to a specific viewability (for example, 80% viewable).", +"Target ads to a specific content category (for example, arts & entertainment).", +"Purchase impressions from specific deals and auction packages.", +"Target ads to a specific language (for example, English or Japanese).", +"Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", +"Target ads to a specific regional location (for example, a city or state).", +"Purchase impressions from a group of deals and auction packages.", +"Purchase impressions from specific exchanges.", +"Purchase impressions from specific sub-exchanges.", +"Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", +"Target ads around locations of a business chain within a specific geo region.", +"Target ads to a specific video content duration.", +"Target ads to a specific video content stream type.", +"Target ads to a specific native content position.", +"Target ads in an Open Measurement enabled inventory.", +"Target ads to a specific audio content type.", +"Target ads to a specific content genre.", +"Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", +"Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.", +"Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources." +], +"type": "string" +} +}, +"type": "object" +}, +"DemandGenBiddingStrategy": { +"description": "Settings that control the bid strategy for Demand Gen resources.", +"id": "DemandGenBiddingStrategy", +"properties": { +"effectiveBiddingValue": { +"description": "Output only. If AG doesn't set value for tCPA or tROAS, line item bidding value will be the effective_bidding_value, if the bidding strategy type is not tCPA or tROAS, effective_bidding_value is always 0. For line item, it will be the same as the value field.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"effectiveBiddingValueSource": { +"description": "Output only. Source of the effective bidding value.", +"enum": [ +"BIDDING_SOURCE_UNSPECIFIED", +"BIDDING_SOURCE_LINE_ITEM", +"BIDDING_SOURCE_AD_GROUP" +], +"enumDescriptions": [ +"Bidding source is not specified or unknown.", +"Bidding value is inherited from the line item.", +"Bidding value is defined in the ad group." +], +"readOnly": true, +"type": "string" +}, +"type": { +"description": "Optional. The type of the bidding strategy. This can only be set at the line item level.", +"enum": [ +"DEMAND_GEN_BIDDING_STRATEGY_TYPE_UNSPECIFIED", +"DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA", +"DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS", +"DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSIONS", +"DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSION_VALUE", +"DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CLICKS" +], +"enumDescriptions": [ +"Type is not specified or unknown.", +"A bidding strategy that automatically optimizes conversions per dollar.", +"A bidding strategy that automatically maximizes revenue while averaging a specific target Return On Ad Spend (ROAS).", +"A bidding strategy that automatically maximizes number of conversions", +"A bidding strategy that automatically maximizes revenue while spending your budget.", +"A bidding strategy that automatically maximizes clicks within a given budget." +], +"type": "string" +}, +"value": { +"description": "Optional. The value used by the bidding strategy. This can be set at the line item and ad group level. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"DemandGenCarouselAd": { +"description": "Details for a Demand Gen carousel ad.", +"id": "DemandGenCarouselAd", +"properties": { +"businessName": { +"description": "Required. The business name shown on the ad.", +"type": "string" +}, +"cards": { +"description": "Required. The list of cards shown on the ad.", +"items": { +"$ref": "CarouselCard" +}, +"type": "array" +}, +"customParameters": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The custom parameters to pass custom values to tracking URL template.", +"type": "object" +}, +"description": { +"description": "Required. The description of the ad.", +"type": "string" +}, +"finalUrl": { +"description": "Required. The URL address of the webpage that people reach after they click the ad.", +"type": "string" +}, +"finalUrlSuffix": { +"description": "Optional. The suffix to append to landing page URLs.", +"type": "string" +}, +"headline": { +"description": "Required. The headline of the ad.", +"type": "string" +}, +"logo": { +"$ref": "ImageAsset", +"description": "Required. The logo image used by this ad." +}, +"trackingUrl": { +"description": "Output only. The URL address loaded in the background for tracking purposes.", +"readOnly": true, +"type": "string" +}, +"userSpecifiedTrackingUrl": { +"description": "Optional. The tracking URL specified by the user manually.", +"type": "string" +} +}, +"type": "object" +}, +"DemandGenImageAd": { +"description": "Details for a Demand Gen image ad.", +"id": "DemandGenImageAd", +"properties": { +"businessName": { +"description": "Required. The business name shown on the ad.", +"type": "string" +}, +"callToAction": { +"description": "Required. The call-to-action button shown on the ad.", +"type": "string" +}, +"customParameters": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The custom parameters to pass custom values to tracking URL template.", +"type": "object" +}, +"descriptions": { +"description": "Required. The list of descriptions shown on the ad.", +"items": { +"type": "string" +}, +"type": "array" +}, +"finalMobileUrl": { +"description": "Optional. The URL address of the webpage that people reach after they click the ad on a mobile device.", +"type": "string" +}, +"finalUrl": { +"description": "Required. The URL address of the webpage that people reach after they click the ad.", +"type": "string" +}, +"finalUrlSuffix": { +"description": "Optional. The suffix to append to landing page URLs.", +"type": "string" +}, +"headlines": { +"description": "Required. The list of headlines shown on the ad.", +"items": { +"type": "string" +}, +"type": "array" +}, +"logoImages": { +"description": "The list of logo images shown on the ad.", +"items": { +"$ref": "ImageAsset" +}, +"type": "array" +}, +"marketingImages": { +"description": "The list of marketing images shown on the ad.", +"items": { +"$ref": "ImageAsset" +}, +"type": "array" +}, +"portraitMarketingImages": { +"description": "The list of portrait marketing images shown on the ad.", +"items": { +"$ref": "ImageAsset" +}, +"type": "array" +}, +"squareMarketingImages": { +"description": "The list of square marketing images shown on the ad.", +"items": { +"$ref": "ImageAsset" +}, +"type": "array" +}, +"trackingUrl": { +"description": "Output only. The URL address loaded in the background for tracking purposes.", +"readOnly": true, +"type": "string" +}, +"userSpecifiedTrackingUrl": { +"description": "Optional. The tracking URL specified by the user manually.", +"type": "string" +} +}, +"type": "object" +}, +"DemandGenProductAd": { +"description": "Details for a Demand Gen product ad.", +"id": "DemandGenProductAd", +"properties": { +"businessName": { +"description": "Required. The business name shown on the ad.", +"type": "string" +}, +"callToAction": { +"description": "Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE`", +"enum": [ +"CALL_TO_ACTION_UNSPECIFIED", +"AUTOMATED", +"LEARN_MORE", +"GET_QUOTE", +"APPLY_NOW", +"SIGN_UP", +"CONTACT_US", +"SUBSCRIBE", +"DOWNLOAD", +"BOOK_NOW", +"SHOP_NOW", +"BUY_NOW", +"DONATE_NOW", +"ORDER_NOW", +"PLAY_NOW", +"SEE_MORE", +"START_NOW", +"VISIT_SITE", +"WATCH_NOW" +], +"enumDescriptions": [ +"Not specified or unknown.", +"Automated.", +"Learn more.", +"Get quote.", +"Apply now.", +"Sign up.", +"Contact us.", +"Subscribe.", +"Download.", +"Book now.", +"Shop now.", +"Buy now.", +"Donate now.", +"Order now.", +"Play now.", +"See more.", +"Start now.", +"Visit site.", +"Watch now." +], +"type": "string" +}, +"customParameters": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The custom parameters to pass custom values to tracking URL template.", +"type": "object" +}, +"description": { +"description": "Required. The description of the ad.", +"type": "string" +}, +"displayUrlBreadcrumb1": { +"description": "Optional. The first piece after the domain in the display URL.", +"type": "string" +}, +"displayUrlBreadcrumb2": { +"description": "Optional. The second piece after the domain in the display URL.", +"type": "string" +}, +"finalUrl": { +"description": "Required. The URL address of the webpage that people reach after they click the ad.", +"type": "string" +}, +"finalUrlSuffix": { +"description": "Optional. The suffix to append to landing page URLs.", +"type": "string" +}, +"headline": { +"description": "Required. The headline of the ad.", +"type": "string" +}, +"logo": { +"$ref": "ImageAsset", +"description": "Required. The logo image used by this ad." +}, +"trackingUrl": { +"description": "Output only. The URL address loaded in the background for tracking purposes.", +"readOnly": true, +"type": "string" +}, +"userSpecifiedTrackingUrl": { +"description": "Optional. The tracking URL specified by the user manually.", +"type": "string" +} +}, +"type": "object" +}, +"DemandGenSettings": { +"description": "Settings for Demand Gen line items.", +"id": "DemandGenSettings", "properties": { -"dayOfWeek": { -"description": "Required. The day of the week for this day and time targeting setting.", -"enum": [ -"DAY_OF_WEEK_UNSPECIFIED", -"MONDAY", -"TUESDAY", -"WEDNESDAY", -"THURSDAY", -"FRIDAY", -"SATURDAY", -"SUNDAY" -], -"enumDescriptions": [ -"The day of the week is unspecified.", -"Monday", -"Tuesday", -"Wednesday", -"Thursday", -"Friday", -"Saturday", -"Sunday" -], +"geoLanguageTargetingEnabled": { +"description": "Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups.", +"type": "boolean" +}, +"linkedMerchantId": { +"description": "Optional. The ID of the merchant which is linked to the line item for product feed.", +"format": "int64", "type": "string" }, -"endHour": { -"description": "Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).", -"format": "int32", -"type": "integer" +"thirdPartyMeasurementConfigs": { +"$ref": "ThirdPartyMeasurementConfigs", +"description": "Optional. The third party measurement settings for the Demand Gen line item." +} }, -"startHour": { -"description": "Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).", -"format": "int32", -"type": "integer" +"type": "object" }, -"timeZoneResolution": { -"description": "Required. The mechanism used to determine which timezone to use for this day and time targeting setting.", +"DemandGenVideoAd": { +"description": "Details for a Demand Gen video ad.", +"id": "DemandGenVideoAd", +"properties": { +"businessName": { +"description": "Required. The business name shown on the ad.", +"type": "string" +}, +"callToAction": { +"description": "Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW`", "enum": [ -"TIME_ZONE_RESOLUTION_UNSPECIFIED", -"TIME_ZONE_RESOLUTION_END_USER", -"TIME_ZONE_RESOLUTION_ADVERTISER" +"CALL_TO_ACTION_UNSPECIFIED", +"AUTOMATED", +"LEARN_MORE", +"GET_QUOTE", +"APPLY_NOW", +"SIGN_UP", +"CONTACT_US", +"SUBSCRIBE", +"DOWNLOAD", +"BOOK_NOW", +"SHOP_NOW", +"BUY_NOW", +"DONATE_NOW", +"ORDER_NOW", +"PLAY_NOW", +"SEE_MORE", +"START_NOW", +"VISIT_SITE", +"WATCH_NOW" ], "enumDescriptions": [ -"Time zone resolution is either unspecific or unknown.", -"Times are resolved in the time zone of the user that saw the ad.", -"Times are resolved in the time zone of the advertiser that served the ad." +"Not specified or unknown.", +"Automated.", +"Learn more.", +"Get quote.", +"Apply now.", +"Sign up.", +"Contact us.", +"Subscribe.", +"Download.", +"Book now.", +"Shop now.", +"Buy now.", +"Donate now.", +"Order now.", +"Play now.", +"See more.", +"Start now.", +"Visit site.", +"Watch now." ], "type": "string" -} }, +"companionBanner": { +"$ref": "ImageAsset", +"description": "Optional. The companion banner used by this ad." +}, +"customParameters": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The custom parameters to pass custom values to tracking URL template.", "type": "object" }, -"DeleteAssignedTargetingOptionsRequest": { -"description": "A request listing which assigned targeting options of a given targeting type should be deleted.", -"id": "DeleteAssignedTargetingOptionsRequest", -"properties": { -"assignedTargetingOptionIds": { -"description": "Required. The assigned targeting option IDs to delete.", +"descriptions": { +"description": "Required. The list of descriptions shown on the ad.", "items": { "type": "string" }, "type": "array" }, -"targetingType": { -"description": "Required. Identifies the type of this assigned targeting option.", -"enum": [ -"TARGETING_TYPE_UNSPECIFIED", -"TARGETING_TYPE_CHANNEL", -"TARGETING_TYPE_APP_CATEGORY", -"TARGETING_TYPE_APP", -"TARGETING_TYPE_URL", -"TARGETING_TYPE_DAY_AND_TIME", -"TARGETING_TYPE_AGE_RANGE", -"TARGETING_TYPE_REGIONAL_LOCATION_LIST", -"TARGETING_TYPE_PROXIMITY_LOCATION_LIST", -"TARGETING_TYPE_GENDER", -"TARGETING_TYPE_VIDEO_PLAYER_SIZE", -"TARGETING_TYPE_USER_REWARDED_CONTENT", -"TARGETING_TYPE_PARENTAL_STATUS", -"TARGETING_TYPE_CONTENT_INSTREAM_POSITION", -"TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", -"TARGETING_TYPE_DEVICE_TYPE", -"TARGETING_TYPE_AUDIENCE_GROUP", -"TARGETING_TYPE_BROWSER", -"TARGETING_TYPE_HOUSEHOLD_INCOME", -"TARGETING_TYPE_ON_SCREEN_POSITION", -"TARGETING_TYPE_THIRD_PARTY_VERIFIER", -"TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", -"TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", -"TARGETING_TYPE_ENVIRONMENT", -"TARGETING_TYPE_CARRIER_AND_ISP", -"TARGETING_TYPE_OPERATING_SYSTEM", -"TARGETING_TYPE_DEVICE_MAKE_MODEL", -"TARGETING_TYPE_KEYWORD", -"TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", -"TARGETING_TYPE_VIEWABILITY", -"TARGETING_TYPE_CATEGORY", -"TARGETING_TYPE_INVENTORY_SOURCE", -"TARGETING_TYPE_LANGUAGE", -"TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", -"TARGETING_TYPE_GEO_REGION", -"TARGETING_TYPE_INVENTORY_SOURCE_GROUP", -"TARGETING_TYPE_EXCHANGE", -"TARGETING_TYPE_SUB_EXCHANGE", -"TARGETING_TYPE_POI", -"TARGETING_TYPE_BUSINESS_CHAIN", -"TARGETING_TYPE_CONTENT_DURATION", -"TARGETING_TYPE_CONTENT_STREAM_TYPE", -"TARGETING_TYPE_NATIVE_CONTENT_POSITION", -"TARGETING_TYPE_OMID", -"TARGETING_TYPE_AUDIO_CONTENT_TYPE", -"TARGETING_TYPE_CONTENT_GENRE", -"TARGETING_TYPE_YOUTUBE_VIDEO", -"TARGETING_TYPE_YOUTUBE_CHANNEL", -"TARGETING_TYPE_SESSION_POSITION", -"TARGETING_TYPE_CONTENT_THEME_EXCLUSION" -], -"enumDescriptions": [ -"Default value when type is not specified or is unknown in this version.", -"Target a channel (a custom group of related websites or apps).", -"Target an app category (for example, education or puzzle games).", -"Target a specific app (for example, Angry Birds).", -"Target a specific url (for example, quora.com).", -"Target ads during a chosen time period on a specific day.", -"Target ads to a specific age range (for example, 18-24).", -"Target ads to the specified regions on a regional location list.", -"Target ads to the specified points of interest on a proximity location list.", -"Target ads to a specific gender (for example, female or male).", -"Target a specific video player size for video ads.", -"Target user rewarded content for video ads.", -"Target ads to a specific parental status (for example, parent or not a parent).", -"Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", -"Target ads in a specific content outstream position.", -"Target ads to a specific device type (for example, tablet or connected TV).", -"Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", -"Target ads to specific web browsers (for example, Chrome).", -"Target ads to a specific household income range (for example, top 10%).", -"Target ads in a specific on screen position.", -"Filter web sites through third party verification (for example, IAS or DoubleVerify).", -"Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", -"Filter website content by sensitive categories (for example, adult).", -"Target ads to a specific environment (for example, web or app).", -"Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", -"Target ads to a specific operating system (for example, macOS).", -"Target ads to a specific device make or model (for example, Roku or Samsung).", -"Target ads to a specific keyword (for example, dog or retriever).", -"Target ads to a specific negative keyword list.", -"Target ads to a specific viewability (for example, 80% viewable).", -"Target ads to a specific content category (for example, arts & entertainment).", -"Purchase impressions from specific deals and auction packages.", -"Target ads to a specific language (for example, English or Japanese).", -"Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", -"Target ads to a specific regional location (for example, a city or state).", -"Purchase impressions from a group of deals and auction packages.", -"Purchase impressions from specific exchanges.", -"Purchase impressions from specific sub-exchanges.", -"Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", -"Target ads around locations of a business chain within a specific geo region.", -"Target ads to a specific video content duration.", -"Target ads to a specific video content stream type.", -"Target ads to a specific native content position.", -"Target ads in an Open Measurement enabled inventory.", -"Target ads to a specific audio content type.", -"Target ads to a specific content genre.", -"Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", -"Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", -"Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API.", -"Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources." -], +"displayUrlBreadcrumb1": { +"description": "Optional. The first piece after the domain in the display URL.", +"type": "string" +}, +"displayUrlBreadcrumb2": { +"description": "Optional. The second piece after the domain in the display URL.", +"type": "string" +}, +"finalMobileUrl": { +"description": "Optional. The URL address of the webpage that people reach after they click the ad on a mobile device.", +"type": "string" +}, +"finalUrl": { +"description": "Required. The URL address of the webpage that people reach after they click the ad.", +"type": "string" +}, +"finalUrlSuffix": { +"description": "Optional. The suffix to append to landing page URLs.", "type": "string" +}, +"headlines": { +"description": "Required. The list of headlines shown on the ad.", +"items": { +"type": "string" +}, +"type": "array" +}, +"logo": { +"$ref": "ImageAsset", +"description": "Required. The logo image used by this ad." +}, +"longHeadlines": { +"description": "Required. The list of lone headlines shown on the ad.", +"items": { +"type": "string" +}, +"type": "array" +}, +"trackingUrl": { +"description": "Output only. The URL address loaded in the background for tracking purposes.", +"readOnly": true, +"type": "string" +}, +"userSpecifiedTrackingUrl": { +"description": "Optional. The tracking URL specified by the user manually.", +"type": "string" +}, +"videos": { +"description": "Required. The list of YouTube video assets used by this ad.", +"items": { +"$ref": "YoutubeVideoDetails" +}, +"type": "array" } }, "type": "object" @@ -17730,6 +18875,11 @@ false "description": "Meta data of an image asset.", "id": "ImageAsset", "properties": { +"assetId": { +"description": "Required. The unique ID of the asset.", +"format": "int64", +"type": "string" +}, "fileSize": { "description": "Output only. File size of the image asset in bytes.", "format": "int64", @@ -17928,7 +19078,7 @@ false "Insertion order automation option is not specified or is unknown in this version.", "Automatic budget allocation. Allow the system to automatically shift budget to owning line items to optimize performance defined by kpi. No automation on bid settings.", "No automation of bid or budget on insertion order level. Bid and budget must be manually configured at the line item level.", -"Allow the system to automatically adjust bids and shift budget to owning line items to optimize performance defined by kpi." +"Allow the system to automatically adjust bids and shift budget to owning line items to optimize performance defined by bid_strategy." ], "type": "string" }, @@ -18858,6 +20008,13 @@ false "description": "Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`.", "id": "KeywordAssignedTargetingOptionDetails", "properties": { +"exemptedPolicyNames": { +"description": "Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted.", +"items": { +"type": "string" +}, +"type": "array" +}, "keyword": { "description": "Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.", "type": "string" @@ -19027,6 +20184,10 @@ false }, "type": "array" }, +"demandGenSettings": { +"$ref": "DemandGenSettings", +"description": "Optional. Settings specific to Demand Gen line items." +}, "displayName": { "description": "Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes.", "type": "string" @@ -19061,7 +20222,7 @@ false }, "frequencyCap": { "$ref": "FrequencyCap", -"description": "Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap." +"description": "Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN." }, "insertionOrderId": { "description": "Required. Immutable. The unique ID of the insertion order that the line item belongs to.", @@ -19102,7 +20263,8 @@ false "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_TARGET_FREQUENCY", "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIEW", "LINE_ITEM_TYPE_DISPLAY_OUT_OF_HOME", -"LINE_ITEM_TYPE_VIDEO_OUT_OF_HOME" +"LINE_ITEM_TYPE_VIDEO_OUT_OF_HOME", +"LINE_ITEM_TYPE_DEMAND_GEN" ], "enumDescriptions": [ "Type value is not specified or is unknown in this version. Line items of this type and their targeting cannot be created or updated using the API.", @@ -19126,7 +20288,8 @@ false "The goal of this line item type is to show the YouTube ads target number of times to the same person in a certain period of time. Line items of this type and their targeting cannot be created or updated using the API.", "YouTube video ads that aim to get more views with a variety of ad formats. Line items of this type and their targeting cannot be created or updated using the API.", "Display ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API.", -"Video ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API." +"Video ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API.", +"Demand Gen ads." ], "type": "string" }, @@ -19248,7 +20411,7 @@ false "id": "LineItemBudget", "properties": { "budgetAllocationType": { -"description": "Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order.", +"description": "Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types.", "enum": [ "LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNSPECIFIED", "LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC", @@ -20953,7 +22116,7 @@ false "type": "string" }, "markupType": { -"description": "Required. The markup type of the partner revenue model.", +"description": "Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`.", "enum": [ "PARTNER_REVENUE_MODEL_MARKUP_TYPE_UNSPECIFIED", "PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM", @@ -21591,9 +22754,9 @@ true, true, true, true, -false, -false, -false, +true, +true, +true, false, false, false @@ -21686,9 +22849,9 @@ true, true, true, true, -false, -false, -false, +true, +true, +true, false, false, false @@ -21770,6 +22933,37 @@ false }, "type": "object" }, +"SelectedInventories": { +"description": "The inventory control of the ad group.", +"id": "SelectedInventories", +"properties": { +"allowDiscover": { +"description": "Whether the ad group is opted-in to Discover inventory.", +"type": "boolean" +}, +"allowGmail": { +"description": "Whether the ad group is opted-in to Gmail inventory.", +"type": "boolean" +}, +"allowGoogleDisplayNetwork": { +"description": "Whether the ad group is opted-in to Google Display Network inventory.", +"type": "boolean" +}, +"allowYoutubeFeed": { +"description": "Whether the ad group is opted-in to YouTube in-feed inventory.", +"type": "boolean" +}, +"allowYoutubeShorts": { +"description": "Whether the ad group is opted-in to YouTube shorts inventory.", +"type": "boolean" +}, +"allowYoutubeStream": { +"description": "Whether the ad group is opted-in to YouTube in-stream.", +"type": "boolean" +} +}, +"type": "object" +}, "SensitiveCategoryAssignedTargetingOptionDetails": { "description": "Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`.", "id": "SensitiveCategoryAssignedTargetingOptionDetails", @@ -22316,28 +23510,28 @@ false "id": "ThirdPartyMeasurementConfigs", "properties": { "brandLiftVendorConfigs": { -"description": "Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_KANTAR_MILLWARD_BROWN` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL`", +"description": "Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL`", "items": { "$ref": "ThirdPartyVendorConfig" }, "type": "array" }, "brandSafetyVendorConfigs": { -"description": "Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_ZEFR`", +"description": "Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR`", "items": { "$ref": "ThirdPartyVendorConfig" }, "type": "array" }, "reachVendorConfigs": { -"description": "Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_KANTAR_MILLWARD_BROWN` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV`", +"description": "Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV` * `THIRD_PARTY_VENDOR_GEMIUS`", "items": { "$ref": "ThirdPartyVendorConfig" }, "type": "array" }, "viewabilityVendorConfigs": { -"description": "Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL`", +"description": "Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS`", "items": { "$ref": "ThirdPartyVendorConfig" }, @@ -22430,7 +23624,16 @@ false "THIRD_PARTY_VENDOR_NIELSEN", "THIRD_PARTY_VENDOR_KANTAR", "THIRD_PARTY_VENDOR_DYNATA", -"THIRD_PARTY_VENDOR_TRANSUNION" +"THIRD_PARTY_VENDOR_TRANSUNION", +"THIRD_PARTY_VENDOR_ORIGIN", +"THIRD_PARTY_VENDOR_GEMIUS", +"THIRD_PARTY_VENDOR_MEDIA_SCOPE", +"THIRD_PARTY_VENDOR_AUDIENCE_PROJECT", +"THIRD_PARTY_VENDOR_VIDEO_AMP", +"THIRD_PARTY_VENDOR_ISPOT_TV", +"THIRD_PARTY_VENDOR_INTAGE", +"THIRD_PARTY_VENDOR_MACROMILL", +"THIRD_PARTY_VENDOR_VIDEO_RESEARCH" ], "enumDescriptions": [ "Unknown third-party vendor.", @@ -22444,7 +23647,16 @@ false "Nielsen.", "Kantar.", "Dynata.", -"Transunion." +"Transunion.", +"Origin.", +"Gemius.", +"MediaScope.", +"Audience Project.", +"Video Amp.", +"Ispot TV.", +"Intage.", +"Macromill.", +"Video Research." ], "type": "string" } From bb33094680a85e7f05dad9c1dbd718e40045befd Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 10 Mar 2026 07:24:06 +0000 Subject: [PATCH 14/31] feat(dlp): update the api #### dlp:v2 The following keys were added: - schemas.GooglePrivacyDlpV2CustomInfoType.properties.metadataKeyValueExpression.$ref (Total Keys: 1) - schemas.GooglePrivacyDlpV2KeyValueMetadataLabel (Total Keys: 3) - schemas.GooglePrivacyDlpV2MetadataKeyValueExpression (Total Keys: 4) - schemas.GooglePrivacyDlpV2MetadataLocation.properties.keyValueMetadataLabel.$ref (Total Keys: 1) --- ...dlp_v2.organizations.inspectTemplates.html | 48 ++++++++++---- ...lp_v2.organizations.locations.dlpJobs.html | 16 +++-- ...tions.locations.fileStoreDataProfiles.html | 16 +++-- ...anizations.locations.inspectTemplates.html | 48 ++++++++++---- ...2.organizations.locations.jobTriggers.html | 48 ++++++++++---- ...nizations.locations.tableDataProfiles.html | 16 +++-- docs/dyn/dlp_v2.projects.content.html | 27 ++++++-- docs/dyn/dlp_v2.projects.dlpJobs.html | 56 ++++++++++++---- docs/dyn/dlp_v2.projects.image.html | 11 +++- .../dyn/dlp_v2.projects.inspectTemplates.html | 48 ++++++++++---- docs/dyn/dlp_v2.projects.jobTriggers.html | 64 ++++++++++++++----- .../dlp_v2.projects.locations.content.html | 27 ++++++-- .../dlp_v2.projects.locations.dlpJobs.html | 56 ++++++++++++---- ...jects.locations.fileStoreDataProfiles.html | 16 +++-- docs/dyn/dlp_v2.projects.locations.image.html | 11 +++- ...2.projects.locations.inspectTemplates.html | 48 ++++++++++---- ...dlp_v2.projects.locations.jobTriggers.html | 64 ++++++++++++++----- ....projects.locations.tableDataProfiles.html | 16 +++-- .../discovery_cache/documents/dlp.v2.json | 50 +++++++++++++-- 19 files changed, 524 insertions(+), 162 deletions(-) diff --git a/docs/dyn/dlp_v2.organizations.inspectTemplates.html b/docs/dyn/dlp_v2.organizations.inspectTemplates.html index 9312b6502c..e76c605d76 100644 --- a/docs/dyn/dlp_v2.organizations.inspectTemplates.html +++ b/docs/dyn/dlp_v2.organizations.inspectTemplates.html @@ -160,6 +160,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -217,7 +221,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -261,7 +265,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -415,6 +419,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -472,7 +480,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -516,7 +524,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -692,6 +700,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -749,7 +761,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -793,7 +805,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -957,6 +969,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -1014,7 +1030,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -1058,7 +1074,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -1229,6 +1245,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -1286,7 +1306,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -1330,7 +1350,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -1483,6 +1503,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -1540,7 +1564,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -1584,7 +1608,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. diff --git a/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html b/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html index 413524e154..ab507c23e9 100644 --- a/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html +++ b/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html @@ -2830,6 +2830,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -2887,7 +2891,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -2931,7 +2935,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -3153,6 +3157,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -3210,7 +3218,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -3254,7 +3262,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. diff --git a/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html b/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html index ef797f9cc9..ea7d146f1c 100644 --- a/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html +++ b/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html @@ -592,6 +592,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -649,7 +653,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -693,7 +697,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -1423,6 +1427,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -1480,7 +1488,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -1524,7 +1532,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. diff --git a/docs/dyn/dlp_v2.organizations.locations.inspectTemplates.html b/docs/dyn/dlp_v2.organizations.locations.inspectTemplates.html index 12247545dc..a7a951f66a 100644 --- a/docs/dyn/dlp_v2.organizations.locations.inspectTemplates.html +++ b/docs/dyn/dlp_v2.organizations.locations.inspectTemplates.html @@ -160,6 +160,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -217,7 +221,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -261,7 +265,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -415,6 +419,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -472,7 +480,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -516,7 +524,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -692,6 +700,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -749,7 +761,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -793,7 +805,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -957,6 +969,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -1014,7 +1030,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -1058,7 +1074,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -1229,6 +1245,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -1286,7 +1306,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -1330,7 +1350,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -1483,6 +1503,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -1540,7 +1564,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -1584,7 +1608,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. diff --git a/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html b/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html index 09c17547d9..84071d56a4 100644 --- a/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html +++ b/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html @@ -226,6 +226,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -283,7 +287,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -327,7 +331,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -641,6 +645,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -698,7 +706,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -742,7 +750,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -1078,6 +1086,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -1135,7 +1147,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -1179,7 +1191,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -1509,6 +1521,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -1566,7 +1582,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -1610,7 +1626,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -1941,6 +1957,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -1998,7 +2018,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -2042,7 +2062,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -2355,6 +2375,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -2412,7 +2436,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -2456,7 +2480,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. diff --git a/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html b/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html index 40f330dc3a..5423a1c0ec 100644 --- a/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html +++ b/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html @@ -592,6 +592,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -649,7 +653,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -693,7 +697,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -1367,6 +1371,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -1424,7 +1432,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -1468,7 +1476,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. diff --git a/docs/dyn/dlp_v2.projects.content.html b/docs/dyn/dlp_v2.projects.content.html index 586a1793ba..84471b9ae2 100644 --- a/docs/dyn/dlp_v2.projects.content.html +++ b/docs/dyn/dlp_v2.projects.content.html @@ -1003,6 +1003,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -1060,7 +1064,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -1104,7 +1108,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -2170,6 +2174,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -2227,7 +2235,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -2271,7 +2279,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -2468,6 +2476,9 @@

Method Details

], }, "metadataLocation": { # Metadata Location # Location within the metadata for inspected content. + "keyValueMetadataLabel": { # The metadata key that contains a finding. # Metadata key that contains the finding. + "key": "A String", # The metadata key. The format depends on the source of the metadata. Examples: - Microsoft Purview Information Protection keys look like 'MSIP_Label_122709e3-8f6b-4860-985f-7f722a94f61e_Enabled', 'MSIP_Label_122709e3-8f6b-4860-985f-7f722a94f61e_Method', 'MSIP_Label_122709e3-8f6b-4860-985f-7f722a94f61e_Name'. - General metadata keys look like 'Author', 'Title', 'Description'. + }, "storageLabel": { # Storage metadata label to indicate which metadata entry contains findings. # Storage metadata. "key": "A String", # Label name. }, @@ -2597,6 +2608,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -2654,7 +2669,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -2698,7 +2713,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. diff --git a/docs/dyn/dlp_v2.projects.dlpJobs.html b/docs/dyn/dlp_v2.projects.dlpJobs.html index e28ac5dd96..0f8b2f38f1 100644 --- a/docs/dyn/dlp_v2.projects.dlpJobs.html +++ b/docs/dyn/dlp_v2.projects.dlpJobs.html @@ -229,6 +229,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -286,7 +290,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -330,7 +334,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -3399,6 +3403,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -3456,7 +3464,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -3500,7 +3508,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -3722,6 +3730,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -3779,7 +3791,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -3823,7 +3835,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -7252,6 +7264,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -7309,7 +7325,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -7353,7 +7369,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -7575,6 +7591,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -7632,7 +7652,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -7676,7 +7696,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -11099,6 +11119,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -11156,7 +11180,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -11200,7 +11224,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -11422,6 +11446,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -11479,7 +11507,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -11523,7 +11551,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. diff --git a/docs/dyn/dlp_v2.projects.image.html b/docs/dyn/dlp_v2.projects.image.html index 824147e3e6..8727622f0d 100644 --- a/docs/dyn/dlp_v2.projects.image.html +++ b/docs/dyn/dlp_v2.projects.image.html @@ -164,6 +164,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -221,7 +225,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -265,7 +269,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -424,6 +428,9 @@

Method Details

], }, "metadataLocation": { # Metadata Location # Location within the metadata for inspected content. + "keyValueMetadataLabel": { # The metadata key that contains a finding. # Metadata key that contains the finding. + "key": "A String", # The metadata key. The format depends on the source of the metadata. Examples: - Microsoft Purview Information Protection keys look like 'MSIP_Label_122709e3-8f6b-4860-985f-7f722a94f61e_Enabled', 'MSIP_Label_122709e3-8f6b-4860-985f-7f722a94f61e_Method', 'MSIP_Label_122709e3-8f6b-4860-985f-7f722a94f61e_Name'. - General metadata keys look like 'Author', 'Title', 'Description'. + }, "storageLabel": { # Storage metadata label to indicate which metadata entry contains findings. # Storage metadata. "key": "A String", # Label name. }, diff --git a/docs/dyn/dlp_v2.projects.inspectTemplates.html b/docs/dyn/dlp_v2.projects.inspectTemplates.html index bbca6c49ee..d46c9dae1c 100644 --- a/docs/dyn/dlp_v2.projects.inspectTemplates.html +++ b/docs/dyn/dlp_v2.projects.inspectTemplates.html @@ -160,6 +160,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -217,7 +221,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -261,7 +265,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -415,6 +419,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -472,7 +480,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -516,7 +524,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -692,6 +700,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -749,7 +761,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -793,7 +805,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -957,6 +969,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -1014,7 +1030,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -1058,7 +1074,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -1229,6 +1245,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -1286,7 +1306,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -1330,7 +1350,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -1483,6 +1503,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -1540,7 +1564,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -1584,7 +1608,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. diff --git a/docs/dyn/dlp_v2.projects.jobTriggers.html b/docs/dyn/dlp_v2.projects.jobTriggers.html index 58fa0d2d51..6f11573b93 100644 --- a/docs/dyn/dlp_v2.projects.jobTriggers.html +++ b/docs/dyn/dlp_v2.projects.jobTriggers.html @@ -2834,6 +2834,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -2891,7 +2895,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -2935,7 +2939,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -3157,6 +3161,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -3214,7 +3222,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -3258,7 +3266,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -4070,6 +4078,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -4127,7 +4139,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -4171,7 +4183,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -4485,6 +4497,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -4542,7 +4558,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -4586,7 +4602,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -4922,6 +4938,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -4979,7 +4999,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -5023,7 +5043,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -5353,6 +5373,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -5410,7 +5434,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -5454,7 +5478,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -5785,6 +5809,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -5842,7 +5870,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -5886,7 +5914,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -6199,6 +6227,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -6256,7 +6288,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -6300,7 +6332,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. diff --git a/docs/dyn/dlp_v2.projects.locations.content.html b/docs/dyn/dlp_v2.projects.locations.content.html index 77fff6179b..8926a3b708 100644 --- a/docs/dyn/dlp_v2.projects.locations.content.html +++ b/docs/dyn/dlp_v2.projects.locations.content.html @@ -1003,6 +1003,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -1060,7 +1064,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -1104,7 +1108,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -2170,6 +2174,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -2227,7 +2235,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -2271,7 +2279,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -2468,6 +2476,9 @@

Method Details

], }, "metadataLocation": { # Metadata Location # Location within the metadata for inspected content. + "keyValueMetadataLabel": { # The metadata key that contains a finding. # Metadata key that contains the finding. + "key": "A String", # The metadata key. The format depends on the source of the metadata. Examples: - Microsoft Purview Information Protection keys look like 'MSIP_Label_122709e3-8f6b-4860-985f-7f722a94f61e_Enabled', 'MSIP_Label_122709e3-8f6b-4860-985f-7f722a94f61e_Method', 'MSIP_Label_122709e3-8f6b-4860-985f-7f722a94f61e_Name'. - General metadata keys look like 'Author', 'Title', 'Description'. + }, "storageLabel": { # Storage metadata label to indicate which metadata entry contains findings. # Storage metadata. "key": "A String", # Label name. }, @@ -2597,6 +2608,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -2654,7 +2669,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -2698,7 +2713,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. diff --git a/docs/dyn/dlp_v2.projects.locations.dlpJobs.html b/docs/dyn/dlp_v2.projects.locations.dlpJobs.html index 75b5163df2..1e121255f9 100644 --- a/docs/dyn/dlp_v2.projects.locations.dlpJobs.html +++ b/docs/dyn/dlp_v2.projects.locations.dlpJobs.html @@ -235,6 +235,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -292,7 +296,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -336,7 +340,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -3405,6 +3409,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -3462,7 +3470,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -3506,7 +3514,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -3728,6 +3736,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -3785,7 +3797,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -3829,7 +3841,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -7282,6 +7294,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -7339,7 +7355,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -7383,7 +7399,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -7605,6 +7621,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -7662,7 +7682,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -7706,7 +7726,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -11217,6 +11237,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -11274,7 +11298,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -11318,7 +11342,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -11540,6 +11564,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -11597,7 +11625,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -11641,7 +11669,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. diff --git a/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html b/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html index 849dacc20b..92e9bfd475 100644 --- a/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html +++ b/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html @@ -592,6 +592,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -649,7 +653,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -693,7 +697,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -1423,6 +1427,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -1480,7 +1488,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -1524,7 +1532,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. diff --git a/docs/dyn/dlp_v2.projects.locations.image.html b/docs/dyn/dlp_v2.projects.locations.image.html index 43f1cf8d37..21e1985673 100644 --- a/docs/dyn/dlp_v2.projects.locations.image.html +++ b/docs/dyn/dlp_v2.projects.locations.image.html @@ -164,6 +164,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -221,7 +225,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -265,7 +269,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -424,6 +428,9 @@

Method Details

], }, "metadataLocation": { # Metadata Location # Location within the metadata for inspected content. + "keyValueMetadataLabel": { # The metadata key that contains a finding. # Metadata key that contains the finding. + "key": "A String", # The metadata key. The format depends on the source of the metadata. Examples: - Microsoft Purview Information Protection keys look like 'MSIP_Label_122709e3-8f6b-4860-985f-7f722a94f61e_Enabled', 'MSIP_Label_122709e3-8f6b-4860-985f-7f722a94f61e_Method', 'MSIP_Label_122709e3-8f6b-4860-985f-7f722a94f61e_Name'. - General metadata keys look like 'Author', 'Title', 'Description'. + }, "storageLabel": { # Storage metadata label to indicate which metadata entry contains findings. # Storage metadata. "key": "A String", # Label name. }, diff --git a/docs/dyn/dlp_v2.projects.locations.inspectTemplates.html b/docs/dyn/dlp_v2.projects.locations.inspectTemplates.html index 0a27973faa..dc951236f9 100644 --- a/docs/dyn/dlp_v2.projects.locations.inspectTemplates.html +++ b/docs/dyn/dlp_v2.projects.locations.inspectTemplates.html @@ -160,6 +160,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -217,7 +221,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -261,7 +265,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -415,6 +419,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -472,7 +480,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -516,7 +524,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -692,6 +700,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -749,7 +761,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -793,7 +805,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -957,6 +969,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -1014,7 +1030,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -1058,7 +1074,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -1229,6 +1245,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -1286,7 +1306,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -1330,7 +1350,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -1483,6 +1503,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -1540,7 +1564,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -1584,7 +1608,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. diff --git a/docs/dyn/dlp_v2.projects.locations.jobTriggers.html b/docs/dyn/dlp_v2.projects.locations.jobTriggers.html index e5784769c3..0fa2b29ffb 100644 --- a/docs/dyn/dlp_v2.projects.locations.jobTriggers.html +++ b/docs/dyn/dlp_v2.projects.locations.jobTriggers.html @@ -2837,6 +2837,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -2894,7 +2898,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -2938,7 +2942,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -3160,6 +3164,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -3217,7 +3225,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -3261,7 +3269,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -4073,6 +4081,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -4130,7 +4142,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -4174,7 +4186,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -4488,6 +4500,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -4545,7 +4561,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -4589,7 +4605,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -4925,6 +4941,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -4982,7 +5002,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -5026,7 +5046,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -5444,6 +5464,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -5501,7 +5525,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -5545,7 +5569,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -5876,6 +5900,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -5933,7 +5961,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -5977,7 +6005,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -6290,6 +6318,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -6347,7 +6379,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -6391,7 +6423,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. diff --git a/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html b/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html index 9ad1c917af..37d5f227ee 100644 --- a/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html +++ b/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html @@ -592,6 +592,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -649,7 +653,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -693,7 +697,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. @@ -1367,6 +1371,10 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. + "metadataKeyValueExpression": { # Configuration for a custom infoType that detects given expression of key-value pair in the metadata. # key-value pairs to detect in the metadata. + "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. + "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. + }, "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, @@ -1424,7 +1432,7 @@

Method Details

"minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. }, ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. + "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. "infoTypes": [ # List of infoTypes this rule set is applied to. { # Type of information detected by the API. @@ -1468,7 +1476,7 @@

Method Details

"version": "A String", # Optional version name for this InfoType. }, ], - "matchingType": "A String", # How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. }, "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. diff --git a/googleapiclient/discovery_cache/documents/dlp.v2.json b/googleapiclient/discovery_cache/documents/dlp.v2.json index e80a843487..3ff17dcd81 100644 --- a/googleapiclient/discovery_cache/documents/dlp.v2.json +++ b/googleapiclient/discovery_cache/documents/dlp.v2.json @@ -5128,7 +5128,7 @@ } } }, -"revision": "20260129", +"revision": "20260228", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { @@ -5238,7 +5238,7 @@ "type": "array" }, "matchingType": { -"description": "How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule.", +"description": "How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule.", "enum": [ "MATCHING_TYPE_UNSPECIFIED", "MATCHING_TYPE_FULL_MATCH", @@ -6839,6 +6839,10 @@ ], "type": "string" }, +"metadataKeyValueExpression": { +"$ref": "GooglePrivacyDlpV2MetadataKeyValueExpression", +"description": "key-value pairs to detect in the metadata." +}, "regex": { "$ref": "GooglePrivacyDlpV2Regex", "description": "Regular expression based CustomInfoType." @@ -8446,6 +8450,7 @@ "SIGNAL_UNSPECIFIED", "MODEL", "TEXT_EMBEDDING", +"EMBEDDING", "VERTEX_PLUGIN", "VECTOR_PLUGIN", "SOURCE_CODE", @@ -8454,7 +8459,8 @@ "enumDescriptions": [ "Unused.", "One or more machine learning models are present.", -"A table appears to be a text embedding.", +"A table appears to contain text embeddings.", +"A table appears to contain embeddings of any type (for example, text, image, multimodal). The `TEXT_EMBEDDING` signal might also be present if the table contains text embeddings.", "The [Cloud SQL Vertex AI](https://cloud.google.com/sql/docs/postgres/integrate-cloud-sql-with-vertex-ai) plugin is installed on the database.", "Support for [Cloud SQL vector embeddings](https://cloud.google.com/sql/docs/mysql/enable-vector-search) is enabled on the database.", "Source code is present.", @@ -9858,7 +9864,7 @@ "type": "array" }, "ruleSet": { -"description": "Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type.", +"description": "Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType.", "items": { "$ref": "GooglePrivacyDlpV2InspectionRuleSet" }, @@ -10309,6 +10315,17 @@ }, "type": "object" }, +"GooglePrivacyDlpV2KeyValueMetadataLabel": { +"description": "The metadata key that contains a finding.", +"id": "GooglePrivacyDlpV2KeyValueMetadataLabel", +"properties": { +"key": { +"description": "The metadata key. The format depends on the source of the metadata. Examples: - Microsoft Purview Information Protection keys look like 'MSIP_Label_122709e3-8f6b-4860-985f-7f722a94f61e_Enabled', 'MSIP_Label_122709e3-8f6b-4860-985f-7f722a94f61e_Method', 'MSIP_Label_122709e3-8f6b-4860-985f-7f722a94f61e_Name'. - General metadata keys look like 'Author', 'Title', 'Description'.", +"type": "string" +} +}, +"type": "object" +}, "GooglePrivacyDlpV2KindExpression": { "description": "A representation of a Datastore kind.", "id": "GooglePrivacyDlpV2KindExpression", @@ -10774,10 +10791,29 @@ "properties": {}, "type": "object" }, +"GooglePrivacyDlpV2MetadataKeyValueExpression": { +"description": "Configuration for a custom infoType that detects given expression of key-value pair in the metadata.", +"id": "GooglePrivacyDlpV2MetadataKeyValueExpression", +"properties": { +"keyRegex": { +"description": "The regular expression for the key. Key should be non-empty.", +"type": "string" +}, +"valueRegex": { +"description": "The regular expression for the value. Value should be non-empty.", +"type": "string" +} +}, +"type": "object" +}, "GooglePrivacyDlpV2MetadataLocation": { "description": "Metadata Location", "id": "GooglePrivacyDlpV2MetadataLocation", "properties": { +"keyValueMetadataLabel": { +"$ref": "GooglePrivacyDlpV2KeyValueMetadataLabel", +"description": "Metadata key that contains the finding." +}, "storageLabel": { "$ref": "GooglePrivacyDlpV2StorageMetadataLabel", "description": "Storage metadata." @@ -10786,11 +10822,13 @@ "description": "Type of metadata containing the finding.", "enum": [ "METADATATYPE_UNSPECIFIED", -"STORAGE_METADATA" +"STORAGE_METADATA", +"CONTENT_METADATA" ], "enumDescriptions": [ "Unused", -"General file metadata provided by Cloud Storage." +"General file metadata provided by Cloud Storage.", +"Metadata extracted from the files." ], "type": "string" } From a7e36973a0f7720d52007c9b472d1cbc5145ec00 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 10 Mar 2026 07:24:06 +0000 Subject: [PATCH 15/31] feat(firebasedataconnect): update the api #### firebasedataconnect:v1 The following keys were added: - schemas.PostgreSql.properties.schema.type (Total Keys: 1) #### firebasedataconnect:v1beta The following keys were added: - schemas.PostgreSql.properties.schema.type (Total Keys: 1) --- ...edataconnect_v1.projects.locations.services.schemas.html | 4 ++++ ...aconnect_v1beta.projects.locations.services.schemas.html | 4 ++++ .../discovery_cache/documents/firebasedataconnect.v1.json | 6 +++++- .../documents/firebasedataconnect.v1beta.json | 6 +++++- 4 files changed, 18 insertions(+), 2 deletions(-) diff --git a/docs/dyn/firebasedataconnect_v1.projects.locations.services.schemas.html b/docs/dyn/firebasedataconnect_v1.projects.locations.services.schemas.html index 7eb4088bc9..31cff4e162 100644 --- a/docs/dyn/firebasedataconnect_v1.projects.locations.services.schemas.html +++ b/docs/dyn/firebasedataconnect_v1.projects.locations.services.schemas.html @@ -127,6 +127,7 @@

Method Details

}, "database": "A String", # Required. Name of the PostgreSQL database. "ephemeral": True or False, # Output only. Ephemeral is true if this data connect service is served from temporary in-memory emulation of Postgres. While Cloud SQL is being provisioned, the data connect service provides the ephemeral service to help developers get started. Once the Cloud SQL is provisioned, Data Connect service will transfer its data on a best-effort basis to the Cloud SQL instance. WARNING: Ephemeral data sources will expire after 24 hour. The data will be lost if they aren't transferred to the Cloud SQL instance. WARNING: When `ephemeral=true`, mutations to the database are not guaranteed to be durably persisted, even if an OK status code is returned. All or parts of the data may be lost or reverted to earlier versions. + "schema": "A String", # Optional. User-configured PostgreSQL schema. Defaults to "public" if not specified. "schemaMigration": "A String", # Optional. Configure how to perform Postgresql schema migration. "schemaValidation": "A String", # Optional. Configure how much Postgresql schema validation to perform. "unlinked": True or False, # No Postgres data source is linked. If set, don't allow `database` and `schema_validation` to be configured. @@ -255,6 +256,7 @@

Method Details

}, "database": "A String", # Required. Name of the PostgreSQL database. "ephemeral": True or False, # Output only. Ephemeral is true if this data connect service is served from temporary in-memory emulation of Postgres. While Cloud SQL is being provisioned, the data connect service provides the ephemeral service to help developers get started. Once the Cloud SQL is provisioned, Data Connect service will transfer its data on a best-effort basis to the Cloud SQL instance. WARNING: Ephemeral data sources will expire after 24 hour. The data will be lost if they aren't transferred to the Cloud SQL instance. WARNING: When `ephemeral=true`, mutations to the database are not guaranteed to be durably persisted, even if an OK status code is returned. All or parts of the data may be lost or reverted to earlier versions. + "schema": "A String", # Optional. User-configured PostgreSQL schema. Defaults to "public" if not specified. "schemaMigration": "A String", # Optional. Configure how to perform Postgresql schema migration. "schemaValidation": "A String", # Optional. Configure how much Postgresql schema validation to perform. "unlinked": True or False, # No Postgres data source is linked. If set, don't allow `database` and `schema_validation` to be configured. @@ -319,6 +321,7 @@

Method Details

}, "database": "A String", # Required. Name of the PostgreSQL database. "ephemeral": True or False, # Output only. Ephemeral is true if this data connect service is served from temporary in-memory emulation of Postgres. While Cloud SQL is being provisioned, the data connect service provides the ephemeral service to help developers get started. Once the Cloud SQL is provisioned, Data Connect service will transfer its data on a best-effort basis to the Cloud SQL instance. WARNING: Ephemeral data sources will expire after 24 hour. The data will be lost if they aren't transferred to the Cloud SQL instance. WARNING: When `ephemeral=true`, mutations to the database are not guaranteed to be durably persisted, even if an OK status code is returned. All or parts of the data may be lost or reverted to earlier versions. + "schema": "A String", # Optional. User-configured PostgreSQL schema. Defaults to "public" if not specified. "schemaMigration": "A String", # Optional. Configure how to perform Postgresql schema migration. "schemaValidation": "A String", # Optional. Configure how much Postgresql schema validation to perform. "unlinked": True or False, # No Postgres data source is linked. If set, don't allow `database` and `schema_validation` to be configured. @@ -390,6 +393,7 @@

Method Details

}, "database": "A String", # Required. Name of the PostgreSQL database. "ephemeral": True or False, # Output only. Ephemeral is true if this data connect service is served from temporary in-memory emulation of Postgres. While Cloud SQL is being provisioned, the data connect service provides the ephemeral service to help developers get started. Once the Cloud SQL is provisioned, Data Connect service will transfer its data on a best-effort basis to the Cloud SQL instance. WARNING: Ephemeral data sources will expire after 24 hour. The data will be lost if they aren't transferred to the Cloud SQL instance. WARNING: When `ephemeral=true`, mutations to the database are not guaranteed to be durably persisted, even if an OK status code is returned. All or parts of the data may be lost or reverted to earlier versions. + "schema": "A String", # Optional. User-configured PostgreSQL schema. Defaults to "public" if not specified. "schemaMigration": "A String", # Optional. Configure how to perform Postgresql schema migration. "schemaValidation": "A String", # Optional. Configure how much Postgresql schema validation to perform. "unlinked": True or False, # No Postgres data source is linked. If set, don't allow `database` and `schema_validation` to be configured. diff --git a/docs/dyn/firebasedataconnect_v1beta.projects.locations.services.schemas.html b/docs/dyn/firebasedataconnect_v1beta.projects.locations.services.schemas.html index 7748a7a90b..abfb544b08 100644 --- a/docs/dyn/firebasedataconnect_v1beta.projects.locations.services.schemas.html +++ b/docs/dyn/firebasedataconnect_v1beta.projects.locations.services.schemas.html @@ -127,6 +127,7 @@

Method Details

}, "database": "A String", # Required. Name of the PostgreSQL database. "ephemeral": True or False, # Output only. Ephemeral is true if this data connect service is served from temporary in-memory emulation of Postgres. While Cloud SQL is being provisioned, the data connect service provides the ephemeral service to help developers get started. Once the Cloud SQL is provisioned, Data Connect service will transfer its data on a best-effort basis to the Cloud SQL instance. WARNING: Ephemeral data sources will expire after 24 hour. The data will be lost if they aren't transferred to the Cloud SQL instance. WARNING: When `ephemeral=true`, mutations to the database are not guaranteed to be durably persisted, even if an OK status code is returned. All or parts of the data may be lost or reverted to earlier versions. + "schema": "A String", # Optional. User-configured PostgreSQL schema. Defaults to "public" if not specified. "schemaMigration": "A String", # Optional. Configure how to perform Postgresql schema migration. "schemaValidation": "A String", # Optional. Configure how much Postgresql schema validation to perform. "unlinked": True or False, # No Postgres data source is linked. If set, don't allow `database` and `schema_validation` to be configured. @@ -255,6 +256,7 @@

Method Details

}, "database": "A String", # Required. Name of the PostgreSQL database. "ephemeral": True or False, # Output only. Ephemeral is true if this data connect service is served from temporary in-memory emulation of Postgres. While Cloud SQL is being provisioned, the data connect service provides the ephemeral service to help developers get started. Once the Cloud SQL is provisioned, Data Connect service will transfer its data on a best-effort basis to the Cloud SQL instance. WARNING: Ephemeral data sources will expire after 24 hour. The data will be lost if they aren't transferred to the Cloud SQL instance. WARNING: When `ephemeral=true`, mutations to the database are not guaranteed to be durably persisted, even if an OK status code is returned. All or parts of the data may be lost or reverted to earlier versions. + "schema": "A String", # Optional. User-configured PostgreSQL schema. Defaults to "public" if not specified. "schemaMigration": "A String", # Optional. Configure how to perform Postgresql schema migration. "schemaValidation": "A String", # Optional. Configure how much Postgresql schema validation to perform. "unlinked": True or False, # No Postgres data source is linked. If set, don't allow `database` and `schema_validation` to be configured. @@ -319,6 +321,7 @@

Method Details

}, "database": "A String", # Required. Name of the PostgreSQL database. "ephemeral": True or False, # Output only. Ephemeral is true if this data connect service is served from temporary in-memory emulation of Postgres. While Cloud SQL is being provisioned, the data connect service provides the ephemeral service to help developers get started. Once the Cloud SQL is provisioned, Data Connect service will transfer its data on a best-effort basis to the Cloud SQL instance. WARNING: Ephemeral data sources will expire after 24 hour. The data will be lost if they aren't transferred to the Cloud SQL instance. WARNING: When `ephemeral=true`, mutations to the database are not guaranteed to be durably persisted, even if an OK status code is returned. All or parts of the data may be lost or reverted to earlier versions. + "schema": "A String", # Optional. User-configured PostgreSQL schema. Defaults to "public" if not specified. "schemaMigration": "A String", # Optional. Configure how to perform Postgresql schema migration. "schemaValidation": "A String", # Optional. Configure how much Postgresql schema validation to perform. "unlinked": True or False, # No Postgres data source is linked. If set, don't allow `database` and `schema_validation` to be configured. @@ -390,6 +393,7 @@

Method Details

}, "database": "A String", # Required. Name of the PostgreSQL database. "ephemeral": True or False, # Output only. Ephemeral is true if this data connect service is served from temporary in-memory emulation of Postgres. While Cloud SQL is being provisioned, the data connect service provides the ephemeral service to help developers get started. Once the Cloud SQL is provisioned, Data Connect service will transfer its data on a best-effort basis to the Cloud SQL instance. WARNING: Ephemeral data sources will expire after 24 hour. The data will be lost if they aren't transferred to the Cloud SQL instance. WARNING: When `ephemeral=true`, mutations to the database are not guaranteed to be durably persisted, even if an OK status code is returned. All or parts of the data may be lost or reverted to earlier versions. + "schema": "A String", # Optional. User-configured PostgreSQL schema. Defaults to "public" if not specified. "schemaMigration": "A String", # Optional. Configure how to perform Postgresql schema migration. "schemaValidation": "A String", # Optional. Configure how much Postgresql schema validation to perform. "unlinked": True or False, # No Postgres data source is linked. If set, don't allow `database` and `schema_validation` to be configured. diff --git a/googleapiclient/discovery_cache/documents/firebasedataconnect.v1.json b/googleapiclient/discovery_cache/documents/firebasedataconnect.v1.json index 08f39c0872..51d44d3b6e 100644 --- a/googleapiclient/discovery_cache/documents/firebasedataconnect.v1.json +++ b/googleapiclient/discovery_cache/documents/firebasedataconnect.v1.json @@ -1165,7 +1165,7 @@ } } }, -"revision": "20260201", +"revision": "20260301", "rootUrl": "https://firebasedataconnect.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -1919,6 +1919,10 @@ "readOnly": true, "type": "boolean" }, +"schema": { +"description": "Optional. User-configured PostgreSQL schema. Defaults to \"public\" if not specified.", +"type": "string" +}, "schemaMigration": { "description": "Optional. Configure how to perform Postgresql schema migration.", "enum": [ diff --git a/googleapiclient/discovery_cache/documents/firebasedataconnect.v1beta.json b/googleapiclient/discovery_cache/documents/firebasedataconnect.v1beta.json index 6460222e13..2f152f38f0 100644 --- a/googleapiclient/discovery_cache/documents/firebasedataconnect.v1beta.json +++ b/googleapiclient/discovery_cache/documents/firebasedataconnect.v1beta.json @@ -1165,7 +1165,7 @@ } } }, -"revision": "20260201", +"revision": "20260301", "rootUrl": "https://firebasedataconnect.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -1919,6 +1919,10 @@ "readOnly": true, "type": "boolean" }, +"schema": { +"description": "Optional. User-configured PostgreSQL schema. Defaults to \"public\" if not specified.", +"type": "string" +}, "schemaMigration": { "description": "Optional. Configure how to perform Postgresql schema migration.", "enum": [ From 735210e8c68f34c049ff629b7933943ded972647 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 10 Mar 2026 07:24:06 +0000 Subject: [PATCH 16/31] feat(firebaseml): update the api #### firebaseml:v2beta The following keys were added: - schemas.GoogleCloudAiplatformV1beta1ImageConfig.properties.prominentPeople.type (Total Keys: 1) --- ....projects.locations.publishers.models.html | 129 +++++++++--------- .../documents/firebaseml.v2beta.json | 42 ++++-- 2 files changed, 94 insertions(+), 77 deletions(-) diff --git a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html index 3aa1725f8a..7751c35a8b 100644 --- a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html +++ b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html @@ -106,11 +106,11 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, @@ -119,12 +119,12 @@

Method Details

"fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # 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. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. - "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "functionCall": { # 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. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. - "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. "boolValue": True or False, # Optional. Represents a boolean value. @@ -137,9 +137,9 @@

Method Details

], "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. "fileData": { # URI based data for function response. # URI based data. @@ -193,6 +193,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -302,11 +303,11 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, @@ -315,12 +316,12 @@

Method Details

"fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # 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. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. - "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "functionCall": { # 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. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. - "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. "boolValue": True or False, # Optional. Represents a boolean value. @@ -333,9 +334,9 @@

Method Details

], "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. "fileData": { # URI based data for function response. # URI based data. @@ -377,7 +378,7 @@

Method Details

}, "tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). - "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. "environment": "A String", # Required. The environment being operated. @@ -635,11 +636,11 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, @@ -648,12 +649,12 @@

Method Details

"fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # 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. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. - "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "functionCall": { # 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. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. - "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. "boolValue": True or False, # Optional. Represents a boolean value. @@ -666,9 +667,9 @@

Method Details

], "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. "fileData": { # URI based data for function response. # URI based data. @@ -722,6 +723,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -841,11 +843,11 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, @@ -854,12 +856,12 @@

Method Details

"fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # 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. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. - "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "functionCall": { # 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. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. - "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. "boolValue": True or False, # Optional. Represents a boolean value. @@ -872,9 +874,9 @@

Method Details

], "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. "fileData": { # URI based data for function response. # URI based data. @@ -916,11 +918,11 @@

Method Details

}, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Tool config. This config is shared for all tools provided in the request. "functionCallingConfig": { # Function calling config. # Optional. Function calling config. - "allowedFunctionNames": [ # Optional. Function names to call. Only set when the Mode is ANY. Function names should match [FunctionDeclaration.name]. With mode set to ANY, model will predict a function call from the set of function names provided. + "allowedFunctionNames": [ # Optional. Function names to call. Only set when the Mode is ANY. Function names should match FunctionDeclaration.name. With mode set to ANY, model will predict a function call from the set of function names provided. "A String", ], "mode": "A String", # Optional. Function calling mode. - "streamFunctionCallArguments": True or False, # Optional. When set to true, arguments of a single function call will be streamed out in multiple parts/contents/responses. Partial parameter results will be returned in the [FunctionCall.partial_args] field. + "streamFunctionCallArguments": True or False, # Optional. When set to true, arguments of a single function call will be streamed out in multiple parts/contents/responses. Partial parameter results will be returned in the `FunctionCall.partial_args` field. }, "retrievalConfig": { # Retrieval config. # Optional. Retrieval config. "languageCode": "A String", # The language code of the user. @@ -932,7 +934,7 @@

Method Details

}, "tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). - "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. "environment": "A String", # Required. The environment being operated. @@ -1186,11 +1188,11 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The content of the candidate. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, @@ -1199,12 +1201,12 @@

Method Details

"fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # 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. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. - "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "functionCall": { # 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. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. - "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. "boolValue": True or False, # Optional. Represents a boolean value. @@ -1217,9 +1219,9 @@

Method Details

], "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. "fileData": { # URI based data for function response. # URI based data. @@ -1464,11 +1466,11 @@

Method Details

{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, @@ -1477,12 +1479,12 @@

Method Details

"fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # 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. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. - "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "functionCall": { # 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. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. - "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. "boolValue": True or False, # Optional. Represents a boolean value. @@ -1495,9 +1497,9 @@

Method Details

], "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. "fileData": { # URI based data for function response. # URI based data. @@ -1551,6 +1553,7 @@

Method Details

}, "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. }, "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. @@ -1670,11 +1673,11 @@

Method Details

"systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, @@ -1683,12 +1686,12 @@

Method Details

"fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # 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. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. - "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "functionCall": { # 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. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. - "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. "boolValue": True or False, # Optional. Represents a boolean value. @@ -1701,9 +1704,9 @@

Method Details

], "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. "fileData": { # URI based data for function response. # URI based data. @@ -1745,11 +1748,11 @@

Method Details

}, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Tool config. This config is shared for all tools provided in the request. "functionCallingConfig": { # Function calling config. # Optional. Function calling config. - "allowedFunctionNames": [ # Optional. Function names to call. Only set when the Mode is ANY. Function names should match [FunctionDeclaration.name]. With mode set to ANY, model will predict a function call from the set of function names provided. + "allowedFunctionNames": [ # Optional. Function names to call. Only set when the Mode is ANY. Function names should match FunctionDeclaration.name. With mode set to ANY, model will predict a function call from the set of function names provided. "A String", ], "mode": "A String", # Optional. Function calling mode. - "streamFunctionCallArguments": True or False, # Optional. When set to true, arguments of a single function call will be streamed out in multiple parts/contents/responses. Partial parameter results will be returned in the [FunctionCall.partial_args] field. + "streamFunctionCallArguments": True or False, # Optional. When set to true, arguments of a single function call will be streamed out in multiple parts/contents/responses. Partial parameter results will be returned in the `FunctionCall.partial_args` field. }, "retrievalConfig": { # Retrieval config. # Optional. Retrieval config. "languageCode": "A String", # The language code of the user. @@ -1761,7 +1764,7 @@

Method Details

}, "tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). - "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. "environment": "A String", # Required. The environment being operated. @@ -2015,11 +2018,11 @@

Method Details

"content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The content of the candidate. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, @@ -2028,12 +2031,12 @@

Method Details

"fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # 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. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. - "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "functionCall": { # 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. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. - "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. { # Partial argument value of the function call. "boolValue": True or False, # Optional. Represents a boolean value. @@ -2046,9 +2049,9 @@

Method Details

], "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. "fileData": { # URI based data for function response. # URI based data. diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json index 25f81532f3..0c66eb0cb1 100644 --- a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +++ b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json @@ -206,7 +206,7 @@ } } }, -"revision": "20260225", +"revision": "20260303", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Date": { @@ -572,7 +572,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1CodeExecutionResult": { -"description": "Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode].", +"description": "Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used.", "id": "GoogleCloudAiplatformV1beta1CodeExecutionResult", "properties": { "outcome": { @@ -585,9 +585,9 @@ ], "enumDescriptions": [ "Unspecified status. This value should not be used.", -"Code execution completed successfully.", -"Code execution finished but with a failure. `stderr` should contain the reason.", -"Code execution ran for too long, and was cancelled. There may or may not be a partial output present." +"Code execution completed successfully. `output` contains the stdout, if any.", +"Code execution failed. `output` contains the stderr and stdout, if any.", +"Code execution ran for too long, and was cancelled. There may or may not be a partial `output` present." ], "type": "string" }, @@ -742,7 +742,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1ExecutableCode": { -"description": "Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated.", +"description": "Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated.", "id": "GoogleCloudAiplatformV1beta1ExecutableCode", "properties": { "code": { @@ -852,7 +852,7 @@ "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.", +"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", "properties": { "args": { @@ -860,7 +860,7 @@ "description": "Properties of the object.", "type": "any" }, -"description": "Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.", +"description": "Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details.", "type": "object" }, "id": { @@ -868,7 +868,7 @@ "type": "string" }, "name": { -"description": "Optional. The name of the function to call. Matches [FunctionDeclaration.name].", +"description": "Optional. The name of the function to call. Matches FunctionDeclaration.name.", "type": "string" }, "partialArgs": { @@ -890,7 +890,7 @@ "id": "GoogleCloudAiplatformV1beta1FunctionCallingConfig", "properties": { "allowedFunctionNames": { -"description": "Optional. Function names to call. Only set when the Mode is ANY. Function names should match [FunctionDeclaration.name]. With mode set to ANY, model will predict a function call from the set of function names provided.", +"description": "Optional. Function names to call. Only set when the Mode is ANY. Function names should match FunctionDeclaration.name. With mode set to ANY, model will predict a function call from the set of function names provided.", "items": { "type": "string" }, @@ -915,7 +915,7 @@ "type": "string" }, "streamFunctionCallArguments": { -"description": "Optional. When set to true, arguments of a single function call will be streamed out in multiple parts/contents/responses. Partial parameter results will be returned in the [FunctionCall.partial_args] field.", +"description": "Optional. When set to true, arguments of a single function call will be streamed out in multiple parts/contents/responses. Partial parameter results will be returned in the `FunctionCall.partial_args` field.", "type": "boolean" } }, @@ -953,7 +953,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1FunctionResponse": { -"description": "The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction.", +"description": "The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction.", "id": "GoogleCloudAiplatformV1beta1FunctionResponse", "properties": { "id": { @@ -961,7 +961,7 @@ "type": "string" }, "name": { -"description": "Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].", +"description": "Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name.", "type": "string" }, "parts": { @@ -1874,6 +1874,20 @@ "Prevents the model from generating images of people." ], "type": "string" +}, +"prominentPeople": { +"description": "Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people.", +"enum": [ +"PROMINENT_PEOPLE_UNSPECIFIED", +"ALLOW_PROMINENT_PEOPLE", +"BLOCK_PROMINENT_PEOPLE" +], +"enumDescriptions": [ +"Unspecified value. The model will proceed with the default behavior, which is to allow generation of prominent people.", +"Allows the model to generate images of prominent people.", +"Prevents the model from generating images of prominent people." +], +"type": "string" } }, "type": "object" @@ -2826,7 +2840,7 @@ false "type": "object" }, "GoogleCloudAiplatformV1beta1ToolCodeExecution": { -"description": "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.", +"description": "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.", "id": "GoogleCloudAiplatformV1beta1ToolCodeExecution", "properties": {}, "type": "object" From 276f7b50506e5cc5223ada3ca289a9f1590a95bf Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 10 Mar 2026 07:24:06 +0000 Subject: [PATCH 17/31] feat(firestore): update the api #### firestore:v1 The following keys were added: - schemas.Value.properties.variableReferenceValue.type (Total Keys: 1) #### firestore:v1beta1 The following keys were added: - schemas.Value.properties.variableReferenceValue.type (Total Keys: 1) --- ...store_v1.projects.databases.documents.html | 62 +++++++++++++++++-- docs/dyn/firestore_v1.projects.databases.html | 16 ++--- ..._v1beta1.projects.databases.documents.html | 62 +++++++++++++++++-- .../documents/firestore.v1.json | 12 ++-- .../documents/firestore.v1beta1.json | 8 ++- 5 files changed, 138 insertions(+), 22 deletions(-) diff --git a/docs/dyn/firestore_v1.projects.databases.documents.html b/docs/dyn/firestore_v1.projects.databases.documents.html index ba284018da..2916b3647d 100644 --- a/docs/dyn/firestore_v1.projects.databases.documents.html +++ b/docs/dyn/firestore_v1.projects.databases.documents.html @@ -232,6 +232,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, }, "name": "A String", # The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`. @@ -319,6 +320,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "maximum": { # A message that can hold any of the supported value types. # Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN. "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain a map which contains another array. @@ -366,6 +368,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "minimum": { # A message that can hold any of the supported value types. # Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN. "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain a map which contains another array. @@ -413,6 +416,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "removeAllFromArray": { # An array value. # Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value. "values": [ # Values in the array. @@ -472,6 +476,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, }, "name": "A String", # The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`. @@ -536,6 +541,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "maximum": { # A message that can hold any of the supported value types. # Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN. "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain a map which contains another array. @@ -583,6 +589,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "minimum": { # A message that can hold any of the supported value types. # Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN. "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain a map which contains another array. @@ -630,6 +637,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "removeAllFromArray": { # An array value. # Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value. "values": [ # Values in the array. @@ -712,6 +720,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, ], "updateTime": "A String", # The last update time of the document after applying the write. Not set after a `delete`. If the write did not actually change the document, this will be the previous update_time. @@ -832,6 +841,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "maximum": { # A message that can hold any of the supported value types. # Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN. "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain a map which contains another array. @@ -879,6 +889,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "minimum": { # A message that can hold any of the supported value types. # Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN. "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain a map which contains another array. @@ -926,6 +937,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "removeAllFromArray": { # An array value. # Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value. "values": [ # Values in the array. @@ -985,6 +997,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, }, "name": "A String", # The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`. @@ -1049,6 +1062,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "maximum": { # A message that can hold any of the supported value types. # Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN. "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain a map which contains another array. @@ -1096,6 +1110,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "minimum": { # A message that can hold any of the supported value types. # Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN. "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain a map which contains another array. @@ -1143,6 +1158,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "removeAllFromArray": { # An array value. # Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value. "values": [ # Values in the array. @@ -1215,6 +1231,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, ], "updateTime": "A String", # The last update time of the document after applying the write. Not set after a `delete`. If the write did not actually change the document, this will be the previous update_time. @@ -1282,6 +1299,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, }, "name": "A String", # The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`. @@ -1347,6 +1365,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, }, "name": "A String", # The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`. @@ -1441,6 +1460,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, }, "pipeline": { # A Firestore query represented as an ordered list of operations / stages. # Required. The pipeline query to execute. @@ -1525,6 +1545,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, }, "name": "A String", # The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`. @@ -1601,6 +1622,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, }, "name": "A String", # The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`. @@ -1681,6 +1703,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, }, "name": "A String", # The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`. @@ -1809,6 +1832,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, }, "name": "A String", # The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`. @@ -1917,6 +1941,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, ], }, @@ -1971,6 +1996,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "vectorField": { # A reference to a field in a document, ex: `stats.operations`. # Required. An indexed vector field to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned. "fieldPath": "A String", # A reference to a field in a document. Requires: * MUST be a dot-delimited (`.`) string of segments, where each segment conforms to document field name limitations. @@ -1984,7 +2010,7 @@

Method Details

], "limit": 42, # The maximum number of results to return. Applies after all other constraints. Requires: * The value must be greater than or equal to zero if specified. "offset": 42, # The number of documents to skip before returning the first result. This applies after the constraints specified by the `WHERE`, `START AT`, & `END AT` but before the `LIMIT` clause. Requires: * The value must be greater than or equal to zero if specified. - "orderBy": [ # The order to apply to the query results. Firestore allows callers to provide a full ordering, a partial ordering, or no ordering at all. In all cases, Firestore guarantees a stable ordering through the following rules: * The `order_by` is required to reference all fields used with an inequality filter. * All fields that are required to be in the `order_by` but are not already present are appended in lexicographical ordering of the field name. * If an order on `__name__` is not specified, it is appended by default. Fields are appended with the same sort direction as the last order specified, or 'ASCENDING' if no order was specified. For example: * `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC` * `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC` * `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC` * `WHERE __name__ > ... AND a > 1` becomes `WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC` + "orderBy": [ # The order to apply to the query results. Callers can provide a full ordering, a partial ordering, or no ordering at all. While Firestore will always respect the provided order, the behavior for queries without a full ordering is different per database edition: In Standard edition, Firestore guarantees a stable ordering through the following rules: * The `order_by` is required to reference all fields used with an inequality filter. * All fields that are required to be in the `order_by` but are not already present are appended in lexicographical ordering of the field name. * If an order on `__name__` is not specified, it is appended by default. Fields are appended with the same sort direction as the last order specified, or 'ASCENDING' if no order was specified. For example: * `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC` * `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC` * `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC` * `WHERE __name__ > ... AND a > 1` becomes `WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC` In Enterprise edition, Firestore does not guarantee a stable ordering. Instead it will pick the most efficient ordering based on the indexes available at the time of query execution. This will result in a different ordering for queries that are otherwise identical. To ensure a stable ordering, always include a unique field in the `order_by` clause, such as `__name__`. { # An order on a field. "direction": "A String", # The direction to order by. Defaults to `ASCENDING`. "field": { # A reference to a field in a document, ex: `stats.operations`. # The field to order by. @@ -2048,6 +2074,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, ], }, @@ -2109,6 +2136,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, }, "unaryFilter": { # A filter with a single operand. # A filter that takes exactly one argument. @@ -2189,6 +2217,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, }, "name": "A String", # The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`. @@ -2310,6 +2339,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, ], }, @@ -2364,6 +2394,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "vectorField": { # A reference to a field in a document, ex: `stats.operations`. # Required. An indexed vector field to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned. "fieldPath": "A String", # A reference to a field in a document. Requires: * MUST be a dot-delimited (`.`) string of segments, where each segment conforms to document field name limitations. @@ -2377,7 +2408,7 @@

Method Details

], "limit": 42, # The maximum number of results to return. Applies after all other constraints. Requires: * The value must be greater than or equal to zero if specified. "offset": 42, # The number of documents to skip before returning the first result. This applies after the constraints specified by the `WHERE`, `START AT`, & `END AT` but before the `LIMIT` clause. Requires: * The value must be greater than or equal to zero if specified. - "orderBy": [ # The order to apply to the query results. Firestore allows callers to provide a full ordering, a partial ordering, or no ordering at all. In all cases, Firestore guarantees a stable ordering through the following rules: * The `order_by` is required to reference all fields used with an inequality filter. * All fields that are required to be in the `order_by` but are not already present are appended in lexicographical ordering of the field name. * If an order on `__name__` is not specified, it is appended by default. Fields are appended with the same sort direction as the last order specified, or 'ASCENDING' if no order was specified. For example: * `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC` * `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC` * `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC` * `WHERE __name__ > ... AND a > 1` becomes `WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC` + "orderBy": [ # The order to apply to the query results. Callers can provide a full ordering, a partial ordering, or no ordering at all. While Firestore will always respect the provided order, the behavior for queries without a full ordering is different per database edition: In Standard edition, Firestore guarantees a stable ordering through the following rules: * The `order_by` is required to reference all fields used with an inequality filter. * All fields that are required to be in the `order_by` but are not already present are appended in lexicographical ordering of the field name. * If an order on `__name__` is not specified, it is appended by default. Fields are appended with the same sort direction as the last order specified, or 'ASCENDING' if no order was specified. For example: * `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC` * `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC` * `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC` * `WHERE __name__ > ... AND a > 1` becomes `WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC` In Enterprise edition, Firestore does not guarantee a stable ordering. Instead it will pick the most efficient ordering based on the indexes available at the time of query execution. This will result in a different ordering for queries that are otherwise identical. To ensure a stable ordering, always include a unique field in the `order_by` clause, such as `__name__`. { # An order on a field. "direction": "A String", # The direction to order by. Defaults to `ASCENDING`. "field": { # A reference to a field in a document, ex: `stats.operations`. # The field to order by. @@ -2441,6 +2472,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, ], }, @@ -2502,6 +2534,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, }, "unaryFilter": { # A filter with a single operand. # A filter that takes exactly one argument. @@ -2574,6 +2607,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, ], }, @@ -2653,6 +2687,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, }, "name": "A String", # The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`. @@ -2720,6 +2755,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, }, "name": "A String", # The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`. @@ -2843,6 +2879,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, ], }, @@ -2897,6 +2934,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "vectorField": { # A reference to a field in a document, ex: `stats.operations`. # Required. An indexed vector field to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned. "fieldPath": "A String", # A reference to a field in a document. Requires: * MUST be a dot-delimited (`.`) string of segments, where each segment conforms to document field name limitations. @@ -2910,7 +2948,7 @@

Method Details

], "limit": 42, # The maximum number of results to return. Applies after all other constraints. Requires: * The value must be greater than or equal to zero if specified. "offset": 42, # The number of documents to skip before returning the first result. This applies after the constraints specified by the `WHERE`, `START AT`, & `END AT` but before the `LIMIT` clause. Requires: * The value must be greater than or equal to zero if specified. - "orderBy": [ # The order to apply to the query results. Firestore allows callers to provide a full ordering, a partial ordering, or no ordering at all. In all cases, Firestore guarantees a stable ordering through the following rules: * The `order_by` is required to reference all fields used with an inequality filter. * All fields that are required to be in the `order_by` but are not already present are appended in lexicographical ordering of the field name. * If an order on `__name__` is not specified, it is appended by default. Fields are appended with the same sort direction as the last order specified, or 'ASCENDING' if no order was specified. For example: * `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC` * `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC` * `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC` * `WHERE __name__ > ... AND a > 1` becomes `WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC` + "orderBy": [ # The order to apply to the query results. Callers can provide a full ordering, a partial ordering, or no ordering at all. While Firestore will always respect the provided order, the behavior for queries without a full ordering is different per database edition: In Standard edition, Firestore guarantees a stable ordering through the following rules: * The `order_by` is required to reference all fields used with an inequality filter. * All fields that are required to be in the `order_by` but are not already present are appended in lexicographical ordering of the field name. * If an order on `__name__` is not specified, it is appended by default. Fields are appended with the same sort direction as the last order specified, or 'ASCENDING' if no order was specified. For example: * `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC` * `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC` * `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC` * `WHERE __name__ > ... AND a > 1` becomes `WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC` In Enterprise edition, Firestore does not guarantee a stable ordering. Instead it will pick the most efficient ordering based on the indexes available at the time of query execution. This will result in a different ordering for queries that are otherwise identical. To ensure a stable ordering, always include a unique field in the `order_by` clause, such as `__name__`. { # An order on a field. "direction": "A String", # The direction to order by. Defaults to `ASCENDING`. "field": { # A reference to a field in a document, ex: `stats.operations`. # The field to order by. @@ -2974,6 +3012,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, ], }, @@ -3035,6 +3074,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, }, "unaryFilter": { # A filter with a single operand. # A filter that takes exactly one argument. @@ -3124,6 +3164,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, }, }, @@ -3203,6 +3244,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, ], }, @@ -3257,6 +3299,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "vectorField": { # A reference to a field in a document, ex: `stats.operations`. # Required. An indexed vector field to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned. "fieldPath": "A String", # A reference to a field in a document. Requires: * MUST be a dot-delimited (`.`) string of segments, where each segment conforms to document field name limitations. @@ -3270,7 +3313,7 @@

Method Details

], "limit": 42, # The maximum number of results to return. Applies after all other constraints. Requires: * The value must be greater than or equal to zero if specified. "offset": 42, # The number of documents to skip before returning the first result. This applies after the constraints specified by the `WHERE`, `START AT`, & `END AT` but before the `LIMIT` clause. Requires: * The value must be greater than or equal to zero if specified. - "orderBy": [ # The order to apply to the query results. Firestore allows callers to provide a full ordering, a partial ordering, or no ordering at all. In all cases, Firestore guarantees a stable ordering through the following rules: * The `order_by` is required to reference all fields used with an inequality filter. * All fields that are required to be in the `order_by` but are not already present are appended in lexicographical ordering of the field name. * If an order on `__name__` is not specified, it is appended by default. Fields are appended with the same sort direction as the last order specified, or 'ASCENDING' if no order was specified. For example: * `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC` * `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC` * `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC` * `WHERE __name__ > ... AND a > 1` becomes `WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC` + "orderBy": [ # The order to apply to the query results. Callers can provide a full ordering, a partial ordering, or no ordering at all. While Firestore will always respect the provided order, the behavior for queries without a full ordering is different per database edition: In Standard edition, Firestore guarantees a stable ordering through the following rules: * The `order_by` is required to reference all fields used with an inequality filter. * All fields that are required to be in the `order_by` but are not already present are appended in lexicographical ordering of the field name. * If an order on `__name__` is not specified, it is appended by default. Fields are appended with the same sort direction as the last order specified, or 'ASCENDING' if no order was specified. For example: * `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC` * `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC` * `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC` * `WHERE __name__ > ... AND a > 1` becomes `WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC` In Enterprise edition, Firestore does not guarantee a stable ordering. Instead it will pick the most efficient ordering based on the indexes available at the time of query execution. This will result in a different ordering for queries that are otherwise identical. To ensure a stable ordering, always include a unique field in the `order_by` clause, such as `__name__`. { # An order on a field. "direction": "A String", # The direction to order by. Defaults to `ASCENDING`. "field": { # A reference to a field in a document, ex: `stats.operations`. # The field to order by. @@ -3334,6 +3377,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, ], }, @@ -3395,6 +3439,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, }, "unaryFilter": { # A filter with a single operand. # A filter that takes exactly one argument. @@ -3466,6 +3511,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, }, "name": "A String", # The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`. @@ -3573,6 +3619,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "maximum": { # A message that can hold any of the supported value types. # Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN. "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain a map which contains another array. @@ -3620,6 +3667,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "minimum": { # A message that can hold any of the supported value types. # Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN. "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain a map which contains another array. @@ -3667,6 +3715,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "removeAllFromArray": { # An array value. # Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value. "values": [ # Values in the array. @@ -3726,6 +3775,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, }, "name": "A String", # The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`. @@ -3790,6 +3840,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "maximum": { # A message that can hold any of the supported value types. # Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN. "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain a map which contains another array. @@ -3837,6 +3888,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "minimum": { # A message that can hold any of the supported value types. # Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN. "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain a map which contains another array. @@ -3884,6 +3936,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "removeAllFromArray": { # An array value. # Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value. "values": [ # Values in the array. @@ -3958,6 +4011,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, ], "updateTime": "A String", # The last update time of the document after applying the write. Not set after a `delete`. If the write did not actually change the document, this will be the previous update_time. diff --git a/docs/dyn/firestore_v1.projects.databases.html b/docs/dyn/firestore_v1.projects.databases.html index 5a63a26f40..163d62ad78 100644 --- a/docs/dyn/firestore_v1.projects.databases.html +++ b/docs/dyn/firestore_v1.projects.databases.html @@ -271,7 +271,7 @@

Method Details

"firestoreDataAccessMode": "A String", # Optional. The Firestore API data access mode to use for this database. If not set on write: - the default value is DATA_ACCESS_MODE_DISABLED for Enterprise Edition. - the default value is DATA_ACCESS_MODE_ENABLED for Standard Edition. "freeTier": True or False, # Output only. Background: Free tier is the ability of a Firestore database to use a small amount of resources every day without being charged. Once usage exceeds the free tier limit further usage is charged. Whether this database can make use of the free tier. Only one database per project can be eligible for the free tier. The first (or next) database that is created in a project without a free tier database will be marked as eligible for the free tier. Databases that are created while there is a free tier database will not be eligible for the free tier. "keyPrefix": "A String", # Output only. The key_prefix for this database. This key_prefix is used, in combination with the project ID ("~") to construct the application ID that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo). - "locationId": "A String", # The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations. + "locationId": "A String", # Required. The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations. "mongodbCompatibleDataAccessMode": "A String", # Optional. The MongoDB compatible API data access mode to use for this database. If not set on write, the default value is DATA_ACCESS_MODE_ENABLED for Enterprise Edition. The value is always DATA_ACCESS_MODE_DISABLED for Standard Edition. "name": "A String", # The resource name of the Database. Format: `projects/{project}/databases/{database}` "pointInTimeRecoveryEnablement": "A String", # Whether to enable the PITR feature on this database. @@ -286,7 +286,7 @@

Method Details

"tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" "a_key": "A String", }, - "type": "A String", # The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose. + "type": "A String", # Required. The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose. "uid": "A String", # Output only. The system-generated UUID4 for this Database. "updateTime": "A String", # Output only. The timestamp at which this database was most recently updated. Note this only includes updates to the database resource and not data contained by the database. "versionRetentionPeriod": "A String", # Output only. The period during which past versions of data are retained in the database. Any read or query can specify a `read_time` within this window, and will read the state of the database at that time. If the PITR feature is enabled, the retention period is 7 days. Otherwise, the retention period is 1 hour. @@ -439,7 +439,7 @@

Method Details

"firestoreDataAccessMode": "A String", # Optional. The Firestore API data access mode to use for this database. If not set on write: - the default value is DATA_ACCESS_MODE_DISABLED for Enterprise Edition. - the default value is DATA_ACCESS_MODE_ENABLED for Standard Edition. "freeTier": True or False, # Output only. Background: Free tier is the ability of a Firestore database to use a small amount of resources every day without being charged. Once usage exceeds the free tier limit further usage is charged. Whether this database can make use of the free tier. Only one database per project can be eligible for the free tier. The first (or next) database that is created in a project without a free tier database will be marked as eligible for the free tier. Databases that are created while there is a free tier database will not be eligible for the free tier. "keyPrefix": "A String", # Output only. The key_prefix for this database. This key_prefix is used, in combination with the project ID ("~") to construct the application ID that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo). - "locationId": "A String", # The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations. + "locationId": "A String", # Required. The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations. "mongodbCompatibleDataAccessMode": "A String", # Optional. The MongoDB compatible API data access mode to use for this database. If not set on write, the default value is DATA_ACCESS_MODE_ENABLED for Enterprise Edition. The value is always DATA_ACCESS_MODE_DISABLED for Standard Edition. "name": "A String", # The resource name of the Database. Format: `projects/{project}/databases/{database}` "pointInTimeRecoveryEnablement": "A String", # Whether to enable the PITR feature on this database. @@ -454,7 +454,7 @@

Method Details

"tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" "a_key": "A String", }, - "type": "A String", # The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose. + "type": "A String", # Required. The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose. "uid": "A String", # Output only. The system-generated UUID4 for this Database. "updateTime": "A String", # Output only. The timestamp at which this database was most recently updated. Note this only includes updates to the database resource and not data contained by the database. "versionRetentionPeriod": "A String", # Output only. The period during which past versions of data are retained in the database. Any read or query can specify a `read_time` within this window, and will read the state of the database at that time. If the PITR feature is enabled, the retention period is 7 days. Otherwise, the retention period is 1 hour. @@ -544,7 +544,7 @@

Method Details

"firestoreDataAccessMode": "A String", # Optional. The Firestore API data access mode to use for this database. If not set on write: - the default value is DATA_ACCESS_MODE_DISABLED for Enterprise Edition. - the default value is DATA_ACCESS_MODE_ENABLED for Standard Edition. "freeTier": True or False, # Output only. Background: Free tier is the ability of a Firestore database to use a small amount of resources every day without being charged. Once usage exceeds the free tier limit further usage is charged. Whether this database can make use of the free tier. Only one database per project can be eligible for the free tier. The first (or next) database that is created in a project without a free tier database will be marked as eligible for the free tier. Databases that are created while there is a free tier database will not be eligible for the free tier. "keyPrefix": "A String", # Output only. The key_prefix for this database. This key_prefix is used, in combination with the project ID ("~") to construct the application ID that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo). - "locationId": "A String", # The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations. + "locationId": "A String", # Required. The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations. "mongodbCompatibleDataAccessMode": "A String", # Optional. The MongoDB compatible API data access mode to use for this database. If not set on write, the default value is DATA_ACCESS_MODE_ENABLED for Enterprise Edition. The value is always DATA_ACCESS_MODE_DISABLED for Standard Edition. "name": "A String", # The resource name of the Database. Format: `projects/{project}/databases/{database}` "pointInTimeRecoveryEnablement": "A String", # Whether to enable the PITR feature on this database. @@ -559,7 +559,7 @@

Method Details

"tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" "a_key": "A String", }, - "type": "A String", # The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose. + "type": "A String", # Required. The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose. "uid": "A String", # Output only. The system-generated UUID4 for this Database. "updateTime": "A String", # Output only. The timestamp at which this database was most recently updated. Note this only includes updates to the database resource and not data contained by the database. "versionRetentionPeriod": "A String", # Output only. The period during which past versions of data are retained in the database. Any read or query can specify a `read_time` within this window, and will read the state of the database at that time. If the PITR feature is enabled, the retention period is 7 days. Otherwise, the retention period is 1 hour. @@ -598,7 +598,7 @@

Method Details

"firestoreDataAccessMode": "A String", # Optional. The Firestore API data access mode to use for this database. If not set on write: - the default value is DATA_ACCESS_MODE_DISABLED for Enterprise Edition. - the default value is DATA_ACCESS_MODE_ENABLED for Standard Edition. "freeTier": True or False, # Output only. Background: Free tier is the ability of a Firestore database to use a small amount of resources every day without being charged. Once usage exceeds the free tier limit further usage is charged. Whether this database can make use of the free tier. Only one database per project can be eligible for the free tier. The first (or next) database that is created in a project without a free tier database will be marked as eligible for the free tier. Databases that are created while there is a free tier database will not be eligible for the free tier. "keyPrefix": "A String", # Output only. The key_prefix for this database. This key_prefix is used, in combination with the project ID ("~") to construct the application ID that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo). - "locationId": "A String", # The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations. + "locationId": "A String", # Required. The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations. "mongodbCompatibleDataAccessMode": "A String", # Optional. The MongoDB compatible API data access mode to use for this database. If not set on write, the default value is DATA_ACCESS_MODE_ENABLED for Enterprise Edition. The value is always DATA_ACCESS_MODE_DISABLED for Standard Edition. "name": "A String", # The resource name of the Database. Format: `projects/{project}/databases/{database}` "pointInTimeRecoveryEnablement": "A String", # Whether to enable the PITR feature on this database. @@ -613,7 +613,7 @@

Method Details

"tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" "a_key": "A String", }, - "type": "A String", # The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose. + "type": "A String", # Required. The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose. "uid": "A String", # Output only. The system-generated UUID4 for this Database. "updateTime": "A String", # Output only. The timestamp at which this database was most recently updated. Note this only includes updates to the database resource and not data contained by the database. "versionRetentionPeriod": "A String", # Output only. The period during which past versions of data are retained in the database. Any read or query can specify a `read_time` within this window, and will read the state of the database at that time. If the PITR feature is enabled, the retention period is 7 days. Otherwise, the retention period is 1 hour. diff --git a/docs/dyn/firestore_v1beta1.projects.databases.documents.html b/docs/dyn/firestore_v1beta1.projects.databases.documents.html index a658d3ad81..fc0e21b055 100644 --- a/docs/dyn/firestore_v1beta1.projects.databases.documents.html +++ b/docs/dyn/firestore_v1beta1.projects.databases.documents.html @@ -232,6 +232,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, }, "name": "A String", # The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`. @@ -319,6 +320,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "maximum": { # A message that can hold any of the supported value types. # Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN. "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain a map which contains another array. @@ -366,6 +368,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "minimum": { # A message that can hold any of the supported value types. # Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN. "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain a map which contains another array. @@ -413,6 +416,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "removeAllFromArray": { # An array value. # Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value. "values": [ # Values in the array. @@ -472,6 +476,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, }, "name": "A String", # The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`. @@ -536,6 +541,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "maximum": { # A message that can hold any of the supported value types. # Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN. "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain a map which contains another array. @@ -583,6 +589,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "minimum": { # A message that can hold any of the supported value types. # Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN. "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain a map which contains another array. @@ -630,6 +637,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "removeAllFromArray": { # An array value. # Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value. "values": [ # Values in the array. @@ -712,6 +720,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, ], "updateTime": "A String", # The last update time of the document after applying the write. Not set after a `delete`. If the write did not actually change the document, this will be the previous update_time. @@ -832,6 +841,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "maximum": { # A message that can hold any of the supported value types. # Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN. "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain a map which contains another array. @@ -879,6 +889,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "minimum": { # A message that can hold any of the supported value types. # Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN. "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain a map which contains another array. @@ -926,6 +937,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "removeAllFromArray": { # An array value. # Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value. "values": [ # Values in the array. @@ -985,6 +997,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, }, "name": "A String", # The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`. @@ -1049,6 +1062,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "maximum": { # A message that can hold any of the supported value types. # Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN. "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain a map which contains another array. @@ -1096,6 +1110,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "minimum": { # A message that can hold any of the supported value types. # Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN. "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain a map which contains another array. @@ -1143,6 +1158,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "removeAllFromArray": { # An array value. # Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value. "values": [ # Values in the array. @@ -1215,6 +1231,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, ], "updateTime": "A String", # The last update time of the document after applying the write. Not set after a `delete`. If the write did not actually change the document, this will be the previous update_time. @@ -1282,6 +1299,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, }, "name": "A String", # The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`. @@ -1347,6 +1365,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, }, "name": "A String", # The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`. @@ -1441,6 +1460,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, }, "pipeline": { # A Firestore query represented as an ordered list of operations / stages. # Required. The pipeline query to execute. @@ -1525,6 +1545,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, }, "name": "A String", # The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`. @@ -1601,6 +1622,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, }, "name": "A String", # The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`. @@ -1681,6 +1703,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, }, "name": "A String", # The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`. @@ -1809,6 +1832,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, }, "name": "A String", # The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`. @@ -1917,6 +1941,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, ], }, @@ -1971,6 +1996,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "vectorField": { # A reference to a field in a document, ex: `stats.operations`. # Required. An indexed vector field to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned. "fieldPath": "A String", # A reference to a field in a document. Requires: * MUST be a dot-delimited (`.`) string of segments, where each segment conforms to document field name limitations. @@ -1984,7 +2010,7 @@

Method Details

], "limit": 42, # The maximum number of results to return. Applies after all other constraints. Requires: * The value must be greater than or equal to zero if specified. "offset": 42, # The number of documents to skip before returning the first result. This applies after the constraints specified by the `WHERE`, `START AT`, & `END AT` but before the `LIMIT` clause. Requires: * The value must be greater than or equal to zero if specified. - "orderBy": [ # The order to apply to the query results. Firestore allows callers to provide a full ordering, a partial ordering, or no ordering at all. In all cases, Firestore guarantees a stable ordering through the following rules: * The `order_by` is required to reference all fields used with an inequality filter. * All fields that are required to be in the `order_by` but are not already present are appended in lexicographical ordering of the field name. * If an order on `__name__` is not specified, it is appended by default. Fields are appended with the same sort direction as the last order specified, or 'ASCENDING' if no order was specified. For example: * `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC` * `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC` * `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC` * `WHERE __name__ > ... AND a > 1` becomes `WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC` + "orderBy": [ # The order to apply to the query results. Callers can provide a full ordering, a partial ordering, or no ordering at all. While Firestore will always respect the provided order, the behavior for queries without a full ordering is different per database edition: In Standard edition, Firestore guarantees a stable ordering through the following rules: * The `order_by` is required to reference all fields used with an inequality filter. * All fields that are required to be in the `order_by` but are not already present are appended in lexicographical ordering of the field name. * If an order on `__name__` is not specified, it is appended by default. Fields are appended with the same sort direction as the last order specified, or 'ASCENDING' if no order was specified. For example: * `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC` * `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC` * `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC` * `WHERE __name__ > ... AND a > 1` becomes `WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC` In Enterprise edition, Firestore does not guarantee a stable ordering. Instead it will pick the most efficient ordering based on the indexes available at the time of query execution. This will result in a different ordering for queries that are otherwise identical. To ensure a stable ordering, always include a unique field in the `order_by` clause, such as `__name__`. { # An order on a field. "direction": "A String", # The direction to order by. Defaults to `ASCENDING`. "field": { # A reference to a field in a document, ex: `stats.operations`. # The field to order by. @@ -2048,6 +2074,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, ], }, @@ -2109,6 +2136,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, }, "unaryFilter": { # A filter with a single operand. # A filter that takes exactly one argument. @@ -2189,6 +2217,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, }, "name": "A String", # The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`. @@ -2310,6 +2339,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, ], }, @@ -2364,6 +2394,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "vectorField": { # A reference to a field in a document, ex: `stats.operations`. # Required. An indexed vector field to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned. "fieldPath": "A String", # A reference to a field in a document. Requires: * MUST be a dot-delimited (`.`) string of segments, where each segment conforms to document field name limitations. @@ -2377,7 +2408,7 @@

Method Details

], "limit": 42, # The maximum number of results to return. Applies after all other constraints. Requires: * The value must be greater than or equal to zero if specified. "offset": 42, # The number of documents to skip before returning the first result. This applies after the constraints specified by the `WHERE`, `START AT`, & `END AT` but before the `LIMIT` clause. Requires: * The value must be greater than or equal to zero if specified. - "orderBy": [ # The order to apply to the query results. Firestore allows callers to provide a full ordering, a partial ordering, or no ordering at all. In all cases, Firestore guarantees a stable ordering through the following rules: * The `order_by` is required to reference all fields used with an inequality filter. * All fields that are required to be in the `order_by` but are not already present are appended in lexicographical ordering of the field name. * If an order on `__name__` is not specified, it is appended by default. Fields are appended with the same sort direction as the last order specified, or 'ASCENDING' if no order was specified. For example: * `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC` * `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC` * `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC` * `WHERE __name__ > ... AND a > 1` becomes `WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC` + "orderBy": [ # The order to apply to the query results. Callers can provide a full ordering, a partial ordering, or no ordering at all. While Firestore will always respect the provided order, the behavior for queries without a full ordering is different per database edition: In Standard edition, Firestore guarantees a stable ordering through the following rules: * The `order_by` is required to reference all fields used with an inequality filter. * All fields that are required to be in the `order_by` but are not already present are appended in lexicographical ordering of the field name. * If an order on `__name__` is not specified, it is appended by default. Fields are appended with the same sort direction as the last order specified, or 'ASCENDING' if no order was specified. For example: * `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC` * `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC` * `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC` * `WHERE __name__ > ... AND a > 1` becomes `WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC` In Enterprise edition, Firestore does not guarantee a stable ordering. Instead it will pick the most efficient ordering based on the indexes available at the time of query execution. This will result in a different ordering for queries that are otherwise identical. To ensure a stable ordering, always include a unique field in the `order_by` clause, such as `__name__`. { # An order on a field. "direction": "A String", # The direction to order by. Defaults to `ASCENDING`. "field": { # A reference to a field in a document, ex: `stats.operations`. # The field to order by. @@ -2441,6 +2472,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, ], }, @@ -2502,6 +2534,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, }, "unaryFilter": { # A filter with a single operand. # A filter that takes exactly one argument. @@ -2574,6 +2607,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, ], }, @@ -2653,6 +2687,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, }, "name": "A String", # The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`. @@ -2720,6 +2755,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, }, "name": "A String", # The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`. @@ -2843,6 +2879,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, ], }, @@ -2897,6 +2934,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "vectorField": { # A reference to a field in a document, ex: `stats.operations`. # Required. An indexed vector field to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned. "fieldPath": "A String", # A reference to a field in a document. Requires: * MUST be a dot-delimited (`.`) string of segments, where each segment conforms to document field name limitations. @@ -2910,7 +2948,7 @@

Method Details

], "limit": 42, # The maximum number of results to return. Applies after all other constraints. Requires: * The value must be greater than or equal to zero if specified. "offset": 42, # The number of documents to skip before returning the first result. This applies after the constraints specified by the `WHERE`, `START AT`, & `END AT` but before the `LIMIT` clause. Requires: * The value must be greater than or equal to zero if specified. - "orderBy": [ # The order to apply to the query results. Firestore allows callers to provide a full ordering, a partial ordering, or no ordering at all. In all cases, Firestore guarantees a stable ordering through the following rules: * The `order_by` is required to reference all fields used with an inequality filter. * All fields that are required to be in the `order_by` but are not already present are appended in lexicographical ordering of the field name. * If an order on `__name__` is not specified, it is appended by default. Fields are appended with the same sort direction as the last order specified, or 'ASCENDING' if no order was specified. For example: * `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC` * `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC` * `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC` * `WHERE __name__ > ... AND a > 1` becomes `WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC` + "orderBy": [ # The order to apply to the query results. Callers can provide a full ordering, a partial ordering, or no ordering at all. While Firestore will always respect the provided order, the behavior for queries without a full ordering is different per database edition: In Standard edition, Firestore guarantees a stable ordering through the following rules: * The `order_by` is required to reference all fields used with an inequality filter. * All fields that are required to be in the `order_by` but are not already present are appended in lexicographical ordering of the field name. * If an order on `__name__` is not specified, it is appended by default. Fields are appended with the same sort direction as the last order specified, or 'ASCENDING' if no order was specified. For example: * `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC` * `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC` * `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC` * `WHERE __name__ > ... AND a > 1` becomes `WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC` In Enterprise edition, Firestore does not guarantee a stable ordering. Instead it will pick the most efficient ordering based on the indexes available at the time of query execution. This will result in a different ordering for queries that are otherwise identical. To ensure a stable ordering, always include a unique field in the `order_by` clause, such as `__name__`. { # An order on a field. "direction": "A String", # The direction to order by. Defaults to `ASCENDING`. "field": { # A reference to a field in a document, ex: `stats.operations`. # The field to order by. @@ -2974,6 +3012,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, ], }, @@ -3035,6 +3074,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, }, "unaryFilter": { # A filter with a single operand. # A filter that takes exactly one argument. @@ -3124,6 +3164,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, }, }, @@ -3203,6 +3244,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, ], }, @@ -3257,6 +3299,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "vectorField": { # A reference to a field in a document, ex: `stats.operations`. # Required. An indexed vector field to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned. "fieldPath": "A String", # A reference to a field in a document. Requires: * MUST be a dot-delimited (`.`) string of segments, where each segment conforms to document field name limitations. @@ -3270,7 +3313,7 @@

Method Details

], "limit": 42, # The maximum number of results to return. Applies after all other constraints. Requires: * The value must be greater than or equal to zero if specified. "offset": 42, # The number of documents to skip before returning the first result. This applies after the constraints specified by the `WHERE`, `START AT`, & `END AT` but before the `LIMIT` clause. Requires: * The value must be greater than or equal to zero if specified. - "orderBy": [ # The order to apply to the query results. Firestore allows callers to provide a full ordering, a partial ordering, or no ordering at all. In all cases, Firestore guarantees a stable ordering through the following rules: * The `order_by` is required to reference all fields used with an inequality filter. * All fields that are required to be in the `order_by` but are not already present are appended in lexicographical ordering of the field name. * If an order on `__name__` is not specified, it is appended by default. Fields are appended with the same sort direction as the last order specified, or 'ASCENDING' if no order was specified. For example: * `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC` * `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC` * `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC` * `WHERE __name__ > ... AND a > 1` becomes `WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC` + "orderBy": [ # The order to apply to the query results. Callers can provide a full ordering, a partial ordering, or no ordering at all. While Firestore will always respect the provided order, the behavior for queries without a full ordering is different per database edition: In Standard edition, Firestore guarantees a stable ordering through the following rules: * The `order_by` is required to reference all fields used with an inequality filter. * All fields that are required to be in the `order_by` but are not already present are appended in lexicographical ordering of the field name. * If an order on `__name__` is not specified, it is appended by default. Fields are appended with the same sort direction as the last order specified, or 'ASCENDING' if no order was specified. For example: * `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC` * `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC` * `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC` * `WHERE __name__ > ... AND a > 1` becomes `WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC` In Enterprise edition, Firestore does not guarantee a stable ordering. Instead it will pick the most efficient ordering based on the indexes available at the time of query execution. This will result in a different ordering for queries that are otherwise identical. To ensure a stable ordering, always include a unique field in the `order_by` clause, such as `__name__`. { # An order on a field. "direction": "A String", # The direction to order by. Defaults to `ASCENDING`. "field": { # A reference to a field in a document, ex: `stats.operations`. # The field to order by. @@ -3334,6 +3377,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, ], }, @@ -3395,6 +3439,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, }, "unaryFilter": { # A filter with a single operand. # A filter that takes exactly one argument. @@ -3466,6 +3511,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, }, "name": "A String", # The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`. @@ -3573,6 +3619,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "maximum": { # A message that can hold any of the supported value types. # Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN. "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain a map which contains another array. @@ -3620,6 +3667,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "minimum": { # A message that can hold any of the supported value types. # Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN. "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain a map which contains another array. @@ -3667,6 +3715,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "removeAllFromArray": { # An array value. # Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value. "values": [ # Values in the array. @@ -3726,6 +3775,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, }, "name": "A String", # The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`. @@ -3790,6 +3840,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "maximum": { # A message that can hold any of the supported value types. # Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN. "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain a map which contains another array. @@ -3837,6 +3888,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "minimum": { # A message that can hold any of the supported value types. # Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN. "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain a map which contains another array. @@ -3884,6 +3936,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, "removeAllFromArray": { # An array value. # Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value. "values": [ # Values in the array. @@ -3958,6 +4011,7 @@

Method Details

"referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + "variableReferenceValue": "A String", # Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document. }, ], "updateTime": "A String", # The last update time of the document after applying the write. Not set after a `delete`. If the write did not actually change the document, this will be the previous update_time. diff --git a/googleapiclient/discovery_cache/documents/firestore.v1.json b/googleapiclient/discovery_cache/documents/firestore.v1.json index ad1c6c805e..aab47e2bc0 100644 --- a/googleapiclient/discovery_cache/documents/firestore.v1.json +++ b/googleapiclient/discovery_cache/documents/firestore.v1.json @@ -2445,7 +2445,7 @@ } } }, -"revision": "20260212", +"revision": "20260304", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -3691,7 +3691,7 @@ "type": "string" }, "locationId": { -"description": "The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations.", +"description": "Required. The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations.", "type": "string" }, "mongodbCompatibleDataAccessMode": { @@ -3758,7 +3758,7 @@ "type": "object" }, "type": { -"description": "The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.", +"description": "Required. The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.", "enum": [ "DATABASE_TYPE_UNSPECIFIED", "FIRESTORE_NATIVE", @@ -5482,7 +5482,7 @@ "type": "integer" }, "orderBy": { -"description": "The order to apply to the query results. Firestore allows callers to provide a full ordering, a partial ordering, or no ordering at all. In all cases, Firestore guarantees a stable ordering through the following rules: * The `order_by` is required to reference all fields used with an inequality filter. * All fields that are required to be in the `order_by` but are not already present are appended in lexicographical ordering of the field name. * If an order on `__name__` is not specified, it is appended by default. Fields are appended with the same sort direction as the last order specified, or 'ASCENDING' if no order was specified. For example: * `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC` * `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC` * `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC` * `WHERE __name__ > ... AND a > 1` becomes `WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC`", +"description": "The order to apply to the query results. Callers can provide a full ordering, a partial ordering, or no ordering at all. While Firestore will always respect the provided order, the behavior for queries without a full ordering is different per database edition: In Standard edition, Firestore guarantees a stable ordering through the following rules: * The `order_by` is required to reference all fields used with an inequality filter. * All fields that are required to be in the `order_by` but are not already present are appended in lexicographical ordering of the field name. * If an order on `__name__` is not specified, it is appended by default. Fields are appended with the same sort direction as the last order specified, or 'ASCENDING' if no order was specified. For example: * `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC` * `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC` * `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC` * `WHERE __name__ > ... AND a > 1` becomes `WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC` In Enterprise edition, Firestore does not guarantee a stable ordering. Instead it will pick the most efficient ordering based on the indexes available at the time of query execution. This will result in a different ordering for queries that are otherwise identical. To ensure a stable ordering, always include a unique field in the `order_by` clause, such as `__name__`.", "items": { "$ref": "Order" }, @@ -5713,6 +5713,10 @@ "description": "A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.", "format": "google-datetime", "type": "string" +}, +"variableReferenceValue": { +"description": "Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document.", +"type": "string" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/firestore.v1beta1.json b/googleapiclient/discovery_cache/documents/firestore.v1beta1.json index dcfad340c9..33407648b9 100644 --- a/googleapiclient/discovery_cache/documents/firestore.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/firestore.v1beta1.json @@ -1441,7 +1441,7 @@ } } }, -"revision": "20260130", +"revision": "20260304", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -3399,7 +3399,7 @@ "type": "integer" }, "orderBy": { -"description": "The order to apply to the query results. Firestore allows callers to provide a full ordering, a partial ordering, or no ordering at all. In all cases, Firestore guarantees a stable ordering through the following rules: * The `order_by` is required to reference all fields used with an inequality filter. * All fields that are required to be in the `order_by` but are not already present are appended in lexicographical ordering of the field name. * If an order on `__name__` is not specified, it is appended by default. Fields are appended with the same sort direction as the last order specified, or 'ASCENDING' if no order was specified. For example: * `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC` * `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC` * `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC` * `WHERE __name__ > ... AND a > 1` becomes `WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC`", +"description": "The order to apply to the query results. Callers can provide a full ordering, a partial ordering, or no ordering at all. While Firestore will always respect the provided order, the behavior for queries without a full ordering is different per database edition: In Standard edition, Firestore guarantees a stable ordering through the following rules: * The `order_by` is required to reference all fields used with an inequality filter. * All fields that are required to be in the `order_by` but are not already present are appended in lexicographical ordering of the field name. * If an order on `__name__` is not specified, it is appended by default. Fields are appended with the same sort direction as the last order specified, or 'ASCENDING' if no order was specified. For example: * `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC` * `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC` * `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC` * `WHERE __name__ > ... AND a > 1` becomes `WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC` In Enterprise edition, Firestore does not guarantee a stable ordering. Instead it will pick the most efficient ordering based on the indexes available at the time of query execution. This will result in a different ordering for queries that are otherwise identical. To ensure a stable ordering, always include a unique field in the `order_by` clause, such as `__name__`.", "items": { "$ref": "Order" }, @@ -3630,6 +3630,10 @@ "description": "A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.", "format": "google-datetime", "type": "string" +}, +"variableReferenceValue": { +"description": "Pointer to a variable defined elsewhere in a pipeline. Unlike `field_reference_value` which references a field within a document, this refers to a variable, defined in a separate namespace than the fields of a document.", +"type": "string" } }, "type": "object" From fabb3a90c212cc2d50af19238588ec928aad8815 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 10 Mar 2026 07:24:06 +0000 Subject: [PATCH 18/31] fix(logging): update the api #### logging:v2 The following keys were changed: - endpoints (Total Keys: 1) --- docs/dyn/logging_v2.entries.html | 6 +++--- .../discovery_cache/documents/logging.v2.json | 9 +++++++-- 2 files changed, 10 insertions(+), 5 deletions(-) diff --git a/docs/dyn/logging_v2.entries.html b/docs/dyn/logging_v2.entries.html index 76284b3941..e0a3f88abe 100644 --- a/docs/dyn/logging_v2.entries.html +++ b/docs/dyn/logging_v2.entries.html @@ -291,7 +291,7 @@

Method Details

"uid": "A String", # A globally unique identifier for all log entries in a sequence of split log entries. All log entries with the same |LogSplit.uid| are assumed to be part of the same sequence of split log entries. }, "textPayload": "A String", # The log entry payload, represented as a Unicode string (UTF-8). - "timestamp": "A String", # Optional. The time the event described by the log entry occurred. This time is used to compute the log entry's age and to enforce the logs retention period. If this field is omitted in a new log entry, then Logging assigns it the current time. Timestamps have nanosecond accuracy, but trailing zeros in the fractional seconds might be omitted when the timestamp is displayed.Incoming log entries must have timestamps that don't exceed the logs retention period (https://cloud.google.com/logging/quotas#logs_retention_periods) in the past, and that don't exceed 24 hours in the future. Log entries outside those time boundaries are rejected by Logging. + "timestamp": "A String", # Optional. The time the event described by the log entry occurred. This time is used to compute the log entry's age and to enforce the logs retention period. If this field is omitted in a new log entry, then Logging assigns it the current time. Timestamps have nanosecond accuracy, but trailing zeros in the fractional seconds might be omitted when the timestamp is displayed. "trace": "A String", # Optional. The trace ID being written to Cloud Trace (https://docs.cloud.google.com/trace/docs) in association with this log entry. For example, if your trace data is stored in the Cloud project "my-trace-project" and if the service that is creating the log entry receives a trace header that includes the trace ID "12345", then the service should use "12345".The REST resource name of the trace is also supported, but using this format is not recommended. An example trace REST resource name is similar to "projects/my-trace-project/traces/12345".The trace field provides the link between logs and traces. By using this field, you can navigate from a log entry to a trace. "traceSampled": True or False, # Optional. The sampling decision of the span associated with the log entry at the time the log entry was created. This field corresponds to the sampled flag in the W3C trace-context specification (https://www.w3.org/TR/trace-context/#sampled-flag). A non-sampled trace value is still useful as a request correlation identifier. The default is False. }, @@ -459,7 +459,7 @@

Method Details

"uid": "A String", # A globally unique identifier for all log entries in a sequence of split log entries. All log entries with the same |LogSplit.uid| are assumed to be part of the same sequence of split log entries. }, "textPayload": "A String", # The log entry payload, represented as a Unicode string (UTF-8). - "timestamp": "A String", # Optional. The time the event described by the log entry occurred. This time is used to compute the log entry's age and to enforce the logs retention period. If this field is omitted in a new log entry, then Logging assigns it the current time. Timestamps have nanosecond accuracy, but trailing zeros in the fractional seconds might be omitted when the timestamp is displayed.Incoming log entries must have timestamps that don't exceed the logs retention period (https://cloud.google.com/logging/quotas#logs_retention_periods) in the past, and that don't exceed 24 hours in the future. Log entries outside those time boundaries are rejected by Logging. + "timestamp": "A String", # Optional. The time the event described by the log entry occurred. This time is used to compute the log entry's age and to enforce the logs retention period. If this field is omitted in a new log entry, then Logging assigns it the current time. Timestamps have nanosecond accuracy, but trailing zeros in the fractional seconds might be omitted when the timestamp is displayed. "trace": "A String", # Optional. The trace ID being written to Cloud Trace (https://docs.cloud.google.com/trace/docs) in association with this log entry. For example, if your trace data is stored in the Cloud project "my-trace-project" and if the service that is creating the log entry receives a trace header that includes the trace ID "12345", then the service should use "12345".The REST resource name of the trace is also supported, but using this format is not recommended. An example trace REST resource name is similar to "projects/my-trace-project/traces/12345".The trace field provides the link between logs and traces. By using this field, you can navigate from a log entry to a trace. "traceSampled": True or False, # Optional. The sampling decision of the span associated with the log entry at the time the log entry was created. This field corresponds to the sampled flag in the W3C trace-context specification (https://www.w3.org/TR/trace-context/#sampled-flag). A non-sampled trace value is still useful as a request correlation identifier. The default is False. }, @@ -603,7 +603,7 @@

Method Details

"uid": "A String", # A globally unique identifier for all log entries in a sequence of split log entries. All log entries with the same |LogSplit.uid| are assumed to be part of the same sequence of split log entries. }, "textPayload": "A String", # The log entry payload, represented as a Unicode string (UTF-8). - "timestamp": "A String", # Optional. The time the event described by the log entry occurred. This time is used to compute the log entry's age and to enforce the logs retention period. If this field is omitted in a new log entry, then Logging assigns it the current time. Timestamps have nanosecond accuracy, but trailing zeros in the fractional seconds might be omitted when the timestamp is displayed.Incoming log entries must have timestamps that don't exceed the logs retention period (https://cloud.google.com/logging/quotas#logs_retention_periods) in the past, and that don't exceed 24 hours in the future. Log entries outside those time boundaries are rejected by Logging. + "timestamp": "A String", # Optional. The time the event described by the log entry occurred. This time is used to compute the log entry's age and to enforce the logs retention period. If this field is omitted in a new log entry, then Logging assigns it the current time. Timestamps have nanosecond accuracy, but trailing zeros in the fractional seconds might be omitted when the timestamp is displayed. "trace": "A String", # Optional. The trace ID being written to Cloud Trace (https://docs.cloud.google.com/trace/docs) in association with this log entry. For example, if your trace data is stored in the Cloud project "my-trace-project" and if the service that is creating the log entry receives a trace header that includes the trace ID "12345", then the service should use "12345".The REST resource name of the trace is also supported, but using this format is not recommended. An example trace REST resource name is similar to "projects/my-trace-project/traces/12345".The trace field provides the link between logs and traces. By using this field, you can navigate from a log entry to a trace. "traceSampled": True or False, # Optional. The sampling decision of the span associated with the log entry at the time the log entry was created. This field corresponds to the sampled flag in the W3C trace-context specification (https://www.w3.org/TR/trace-context/#sampled-flag). A non-sampled trace value is still useful as a request correlation identifier. The default is False. }, diff --git a/googleapiclient/discovery_cache/documents/logging.v2.json b/googleapiclient/discovery_cache/documents/logging.v2.json index 7aa38da256..1128c8de63 100644 --- a/googleapiclient/discovery_cache/documents/logging.v2.json +++ b/googleapiclient/discovery_cache/documents/logging.v2.json @@ -270,6 +270,11 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://logging.ca.rep.googleapis.com/", +"location": "ca" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://logging.ch.rep.googleapis.com/", "location": "ch" }, @@ -9157,7 +9162,7 @@ } } }, -"revision": "20260130", +"revision": "20260227", "rootUrl": "https://logging.googleapis.com/", "schemas": { "AppHub": { @@ -10607,7 +10612,7 @@ "type": "string" }, "timestamp": { -"description": "Optional. The time the event described by the log entry occurred. This time is used to compute the log entry's age and to enforce the logs retention period. If this field is omitted in a new log entry, then Logging assigns it the current time. Timestamps have nanosecond accuracy, but trailing zeros in the fractional seconds might be omitted when the timestamp is displayed.Incoming log entries must have timestamps that don't exceed the logs retention period (https://cloud.google.com/logging/quotas#logs_retention_periods) in the past, and that don't exceed 24 hours in the future. Log entries outside those time boundaries are rejected by Logging.", +"description": "Optional. The time the event described by the log entry occurred. This time is used to compute the log entry's age and to enforce the logs retention period. If this field is omitted in a new log entry, then Logging assigns it the current time. Timestamps have nanosecond accuracy, but trailing zeros in the fractional seconds might be omitted when the timestamp is displayed.", "format": "google-datetime", "type": "string" }, From 3c5b82060080e05ef87b14f20dcd1816f03f1f79 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 10 Mar 2026 07:24:06 +0000 Subject: [PATCH 19/31] feat(merchantapi): update the api #### merchantapi:promotions_v1beta The following keys were added: - schemas.Attributes.properties.maxMoneyOffAmount.$ref (Total Keys: 1) - schemas.Attributes.properties.maxPercentOff (Total Keys: 2) - schemas.Attributes.properties.minMoneyOffAmount.$ref (Total Keys: 1) - schemas.Attributes.properties.minPercentOff (Total Keys: 2) --- ...i_datasources_v1.accounts.dataSources.html | 48 ++-- ...tasources_v1beta.accounts.dataSources.html | 48 ++-- ...promotions_v1beta.accounts.promotions.html | 240 ++++++++++-------- .../documents/merchantapi.datasources_v1.json | 10 +- .../merchantapi.datasources_v1beta.json | 10 +- .../merchantapi.promotions_v1beta.json | 82 +++--- 6 files changed, 250 insertions(+), 188 deletions(-) diff --git a/docs/dyn/merchantapi_datasources_v1.accounts.dataSources.html b/docs/dyn/merchantapi_datasources_v1.accounts.dataSources.html index d760b01c98..8428ac8a26 100644 --- a/docs/dyn/merchantapi_datasources_v1.accounts.dataSources.html +++ b/docs/dyn/merchantapi_datasources_v1.accounts.dataSources.html @@ -144,7 +144,7 @@

Method Details

"input": "A String", # Output only. Determines the type of input to the data source. Based on the input some settings might not work. Only generic data sources can be created through the API. "localInventoryDataSource": { # The local inventory data source type is only available for file inputs and can't be used to create API local inventory data sources. # The [local inventory](https://support.google.com/merchants/answer/7023001) data source. "contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the local inventory is provided. - "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). + "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). }, "merchantReviewDataSource": { # The merchant review data source. # The [merchant review](https://support.google.com/merchants/answer/7045996) data source. }, @@ -169,7 +169,7 @@

Method Details

"state": "A String", # The state of the destination. }, ], - "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. + "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). For more information about feed label, see [Create a primary data source for products](https://developers.google.com/merchant/api/guides/data-sources/api-sources#create-primary-data-source). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. "legacyLocal": True or False, # Optional. Immutable. Determines whether the products of this data source are **only** targeting local destinations. Legacy local products are prefixed with `local~` in the product resource ID. For example, `accounts/123/products/local~en~US~sku123`. }, "productReviewDataSource": { # The product review data source. # The [product review](https://support.google.com/merchants/answer/7045996) data source. @@ -180,11 +180,11 @@

Method Details

}, "regionalInventoryDataSource": { # The [regional inventory](https://support.google.com/merchants/answer/7439058) data source. "contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the regional inventory is provided. - "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the regional inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). + "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the regional inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). }, "supplementalProductDataSource": { # The [supplemental data source](https://developers.google.com/merchant/api/guides/data-sources/api-sources#link-supplemental-data-source) for local and online products. After creation,you should make sure to link the supplemental product data source into one or more primary product data sources. # The [supplemental data source](https://support.google.com/merchants/answer/7439058) for local and online products. "contentLanguage": "A String", # Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source. `feedLabel` and `contentLanguage` must be either both set or unset. The fields can only be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. - "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. + "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. "referencingPrimaryDataSources": [ # Output only. The (unordered and deduplicated) list of all primary data sources linked to this data source in either default or custom rules. Supplemental data source cannot be deleted before all links are removed. { # Data source reference can be used to manage related data sources within the data source service. "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` @@ -229,7 +229,7 @@

Method Details

"input": "A String", # Output only. Determines the type of input to the data source. Based on the input some settings might not work. Only generic data sources can be created through the API. "localInventoryDataSource": { # The local inventory data source type is only available for file inputs and can't be used to create API local inventory data sources. # The [local inventory](https://support.google.com/merchants/answer/7023001) data source. "contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the local inventory is provided. - "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). + "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). }, "merchantReviewDataSource": { # The merchant review data source. # The [merchant review](https://support.google.com/merchants/answer/7045996) data source. }, @@ -254,7 +254,7 @@

Method Details

"state": "A String", # The state of the destination. }, ], - "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. + "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). For more information about feed label, see [Create a primary data source for products](https://developers.google.com/merchant/api/guides/data-sources/api-sources#create-primary-data-source). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. "legacyLocal": True or False, # Optional. Immutable. Determines whether the products of this data source are **only** targeting local destinations. Legacy local products are prefixed with `local~` in the product resource ID. For example, `accounts/123/products/local~en~US~sku123`. }, "productReviewDataSource": { # The product review data source. # The [product review](https://support.google.com/merchants/answer/7045996) data source. @@ -265,11 +265,11 @@

Method Details

}, "regionalInventoryDataSource": { # The [regional inventory](https://support.google.com/merchants/answer/7439058) data source. "contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the regional inventory is provided. - "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the regional inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). + "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the regional inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). }, "supplementalProductDataSource": { # The [supplemental data source](https://developers.google.com/merchant/api/guides/data-sources/api-sources#link-supplemental-data-source) for local and online products. After creation,you should make sure to link the supplemental product data source into one or more primary product data sources. # The [supplemental data source](https://support.google.com/merchants/answer/7439058) for local and online products. "contentLanguage": "A String", # Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source. `feedLabel` and `contentLanguage` must be either both set or unset. The fields can only be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. - "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. + "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. "referencingPrimaryDataSources": [ # Output only. The (unordered and deduplicated) list of all primary data sources linked to this data source in either default or custom rules. Supplemental data source cannot be deleted before all links are removed. { # Data source reference can be used to manage related data sources within the data source service. "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` @@ -363,7 +363,7 @@

Method Details

"input": "A String", # Output only. Determines the type of input to the data source. Based on the input some settings might not work. Only generic data sources can be created through the API. "localInventoryDataSource": { # The local inventory data source type is only available for file inputs and can't be used to create API local inventory data sources. # The [local inventory](https://support.google.com/merchants/answer/7023001) data source. "contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the local inventory is provided. - "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). + "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). }, "merchantReviewDataSource": { # The merchant review data source. # The [merchant review](https://support.google.com/merchants/answer/7045996) data source. }, @@ -388,7 +388,7 @@

Method Details

"state": "A String", # The state of the destination. }, ], - "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. + "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). For more information about feed label, see [Create a primary data source for products](https://developers.google.com/merchant/api/guides/data-sources/api-sources#create-primary-data-source). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. "legacyLocal": True or False, # Optional. Immutable. Determines whether the products of this data source are **only** targeting local destinations. Legacy local products are prefixed with `local~` in the product resource ID. For example, `accounts/123/products/local~en~US~sku123`. }, "productReviewDataSource": { # The product review data source. # The [product review](https://support.google.com/merchants/answer/7045996) data source. @@ -399,11 +399,11 @@

Method Details

}, "regionalInventoryDataSource": { # The [regional inventory](https://support.google.com/merchants/answer/7439058) data source. "contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the regional inventory is provided. - "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the regional inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). + "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the regional inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). }, "supplementalProductDataSource": { # The [supplemental data source](https://developers.google.com/merchant/api/guides/data-sources/api-sources#link-supplemental-data-source) for local and online products. After creation,you should make sure to link the supplemental product data source into one or more primary product data sources. # The [supplemental data source](https://support.google.com/merchants/answer/7439058) for local and online products. "contentLanguage": "A String", # Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source. `feedLabel` and `contentLanguage` must be either both set or unset. The fields can only be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. - "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. + "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. "referencingPrimaryDataSources": [ # Output only. The (unordered and deduplicated) list of all primary data sources linked to this data source in either default or custom rules. Supplemental data source cannot be deleted before all links are removed. { # Data source reference can be used to manage related data sources within the data source service. "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` @@ -459,7 +459,7 @@

Method Details

"input": "A String", # Output only. Determines the type of input to the data source. Based on the input some settings might not work. Only generic data sources can be created through the API. "localInventoryDataSource": { # The local inventory data source type is only available for file inputs and can't be used to create API local inventory data sources. # The [local inventory](https://support.google.com/merchants/answer/7023001) data source. "contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the local inventory is provided. - "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). + "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). }, "merchantReviewDataSource": { # The merchant review data source. # The [merchant review](https://support.google.com/merchants/answer/7045996) data source. }, @@ -484,7 +484,7 @@

Method Details

"state": "A String", # The state of the destination. }, ], - "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. + "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). For more information about feed label, see [Create a primary data source for products](https://developers.google.com/merchant/api/guides/data-sources/api-sources#create-primary-data-source). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. "legacyLocal": True or False, # Optional. Immutable. Determines whether the products of this data source are **only** targeting local destinations. Legacy local products are prefixed with `local~` in the product resource ID. For example, `accounts/123/products/local~en~US~sku123`. }, "productReviewDataSource": { # The product review data source. # The [product review](https://support.google.com/merchants/answer/7045996) data source. @@ -495,11 +495,11 @@

Method Details

}, "regionalInventoryDataSource": { # The [regional inventory](https://support.google.com/merchants/answer/7439058) data source. "contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the regional inventory is provided. - "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the regional inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). + "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the regional inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). }, "supplementalProductDataSource": { # The [supplemental data source](https://developers.google.com/merchant/api/guides/data-sources/api-sources#link-supplemental-data-source) for local and online products. After creation,you should make sure to link the supplemental product data source into one or more primary product data sources. # The [supplemental data source](https://support.google.com/merchants/answer/7439058) for local and online products. "contentLanguage": "A String", # Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source. `feedLabel` and `contentLanguage` must be either both set or unset. The fields can only be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. - "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. + "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. "referencingPrimaryDataSources": [ # Output only. The (unordered and deduplicated) list of all primary data sources linked to this data source in either default or custom rules. Supplemental data source cannot be deleted before all links are removed. { # Data source reference can be used to manage related data sources within the data source service. "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` @@ -563,7 +563,7 @@

Method Details

"input": "A String", # Output only. Determines the type of input to the data source. Based on the input some settings might not work. Only generic data sources can be created through the API. "localInventoryDataSource": { # The local inventory data source type is only available for file inputs and can't be used to create API local inventory data sources. # The [local inventory](https://support.google.com/merchants/answer/7023001) data source. "contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the local inventory is provided. - "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). + "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). }, "merchantReviewDataSource": { # The merchant review data source. # The [merchant review](https://support.google.com/merchants/answer/7045996) data source. }, @@ -588,7 +588,7 @@

Method Details

"state": "A String", # The state of the destination. }, ], - "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. + "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). For more information about feed label, see [Create a primary data source for products](https://developers.google.com/merchant/api/guides/data-sources/api-sources#create-primary-data-source). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. "legacyLocal": True or False, # Optional. Immutable. Determines whether the products of this data source are **only** targeting local destinations. Legacy local products are prefixed with `local~` in the product resource ID. For example, `accounts/123/products/local~en~US~sku123`. }, "productReviewDataSource": { # The product review data source. # The [product review](https://support.google.com/merchants/answer/7045996) data source. @@ -599,11 +599,11 @@

Method Details

}, "regionalInventoryDataSource": { # The [regional inventory](https://support.google.com/merchants/answer/7439058) data source. "contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the regional inventory is provided. - "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the regional inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). + "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the regional inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). }, "supplementalProductDataSource": { # The [supplemental data source](https://developers.google.com/merchant/api/guides/data-sources/api-sources#link-supplemental-data-source) for local and online products. After creation,you should make sure to link the supplemental product data source into one or more primary product data sources. # The [supplemental data source](https://support.google.com/merchants/answer/7439058) for local and online products. "contentLanguage": "A String", # Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source. `feedLabel` and `contentLanguage` must be either both set or unset. The fields can only be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. - "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. + "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. "referencingPrimaryDataSources": [ # Output only. The (unordered and deduplicated) list of all primary data sources linked to this data source in either default or custom rules. Supplemental data source cannot be deleted before all links are removed. { # Data source reference can be used to manage related data sources within the data source service. "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` @@ -649,7 +649,7 @@

Method Details

"input": "A String", # Output only. Determines the type of input to the data source. Based on the input some settings might not work. Only generic data sources can be created through the API. "localInventoryDataSource": { # The local inventory data source type is only available for file inputs and can't be used to create API local inventory data sources. # The [local inventory](https://support.google.com/merchants/answer/7023001) data source. "contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the local inventory is provided. - "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). + "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). }, "merchantReviewDataSource": { # The merchant review data source. # The [merchant review](https://support.google.com/merchants/answer/7045996) data source. }, @@ -674,7 +674,7 @@

Method Details

"state": "A String", # The state of the destination. }, ], - "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. + "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). For more information about feed label, see [Create a primary data source for products](https://developers.google.com/merchant/api/guides/data-sources/api-sources#create-primary-data-source). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. "legacyLocal": True or False, # Optional. Immutable. Determines whether the products of this data source are **only** targeting local destinations. Legacy local products are prefixed with `local~` in the product resource ID. For example, `accounts/123/products/local~en~US~sku123`. }, "productReviewDataSource": { # The product review data source. # The [product review](https://support.google.com/merchants/answer/7045996) data source. @@ -685,11 +685,11 @@

Method Details

}, "regionalInventoryDataSource": { # The [regional inventory](https://support.google.com/merchants/answer/7439058) data source. "contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the regional inventory is provided. - "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the regional inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). + "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the regional inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). }, "supplementalProductDataSource": { # The [supplemental data source](https://developers.google.com/merchant/api/guides/data-sources/api-sources#link-supplemental-data-source) for local and online products. After creation,you should make sure to link the supplemental product data source into one or more primary product data sources. # The [supplemental data source](https://support.google.com/merchants/answer/7439058) for local and online products. "contentLanguage": "A String", # Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source. `feedLabel` and `contentLanguage` must be either both set or unset. The fields can only be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. - "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. + "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. "referencingPrimaryDataSources": [ # Output only. The (unordered and deduplicated) list of all primary data sources linked to this data source in either default or custom rules. Supplemental data source cannot be deleted before all links are removed. { # Data source reference can be used to manage related data sources within the data source service. "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` diff --git a/docs/dyn/merchantapi_datasources_v1beta.accounts.dataSources.html b/docs/dyn/merchantapi_datasources_v1beta.accounts.dataSources.html index 1e7cd197e0..24de2e0e8a 100644 --- a/docs/dyn/merchantapi_datasources_v1beta.accounts.dataSources.html +++ b/docs/dyn/merchantapi_datasources_v1beta.accounts.dataSources.html @@ -144,7 +144,7 @@

Method Details

"input": "A String", # Output only. Determines the type of input to the data source. Based on the input some settings might not work. Only generic data sources can be created through the API. "localInventoryDataSource": { # The local inventory data source type is only available for file inputs and can't be used to create API local inventory data sources. # The [local inventory](https://support.google.com/merchants/answer/7023001) data source. "contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the local inventory is provided. - "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). + "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). }, "merchantReviewDataSource": { # The merchant review data source. # The [merchant review](https://support.google.com/merchants/answer/7045996) data source. }, @@ -170,7 +170,7 @@

Method Details

"state": "A String", # The state of the destination. }, ], - "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. + "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). For more information about feed label, see [Create a primary data source for products](https://developers.google.com/merchant/api/guides/data-sources/api-sources#create-primary-data-source). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. }, "productReviewDataSource": { # The product review data source. # The [product review](https://support.google.com/merchants/answer/7045996) data source. }, @@ -180,11 +180,11 @@

Method Details

}, "regionalInventoryDataSource": { # The [regional inventory](https://support.google.com/merchants/answer/7439058) data source. "contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the regional inventory is provided. - "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the regional inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). + "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the regional inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). }, "supplementalProductDataSource": { # The [supplemental data source](https://developers.google.com/merchant/api/guides/data-sources/api-sources#link-supplemental-data-source) for local and online products. After creation,you should make sure to link the supplemental product data source into one or more primary product data sources. # The [supplemental data source](https://support.google.com/merchants/answer/7439058) for local and online products. "contentLanguage": "A String", # Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source. `feedLabel` and `contentLanguage` must be either both set or unset. The fields can only be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. - "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. + "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. "referencingPrimaryDataSources": [ # Output only. The (unordered and deduplicated) list of all primary data sources linked to this data source in either default or custom rules. Supplemental data source cannot be deleted before all links are removed. { # Data source reference can be used to manage related data sources within the data source service. "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` @@ -229,7 +229,7 @@

Method Details

"input": "A String", # Output only. Determines the type of input to the data source. Based on the input some settings might not work. Only generic data sources can be created through the API. "localInventoryDataSource": { # The local inventory data source type is only available for file inputs and can't be used to create API local inventory data sources. # The [local inventory](https://support.google.com/merchants/answer/7023001) data source. "contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the local inventory is provided. - "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). + "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). }, "merchantReviewDataSource": { # The merchant review data source. # The [merchant review](https://support.google.com/merchants/answer/7045996) data source. }, @@ -255,7 +255,7 @@

Method Details

"state": "A String", # The state of the destination. }, ], - "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. + "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). For more information about feed label, see [Create a primary data source for products](https://developers.google.com/merchant/api/guides/data-sources/api-sources#create-primary-data-source). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. }, "productReviewDataSource": { # The product review data source. # The [product review](https://support.google.com/merchants/answer/7045996) data source. }, @@ -265,11 +265,11 @@

Method Details

}, "regionalInventoryDataSource": { # The [regional inventory](https://support.google.com/merchants/answer/7439058) data source. "contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the regional inventory is provided. - "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the regional inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). + "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the regional inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). }, "supplementalProductDataSource": { # The [supplemental data source](https://developers.google.com/merchant/api/guides/data-sources/api-sources#link-supplemental-data-source) for local and online products. After creation,you should make sure to link the supplemental product data source into one or more primary product data sources. # The [supplemental data source](https://support.google.com/merchants/answer/7439058) for local and online products. "contentLanguage": "A String", # Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source. `feedLabel` and `contentLanguage` must be either both set or unset. The fields can only be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. - "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. + "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. "referencingPrimaryDataSources": [ # Output only. The (unordered and deduplicated) list of all primary data sources linked to this data source in either default or custom rules. Supplemental data source cannot be deleted before all links are removed. { # Data source reference can be used to manage related data sources within the data source service. "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` @@ -363,7 +363,7 @@

Method Details

"input": "A String", # Output only. Determines the type of input to the data source. Based on the input some settings might not work. Only generic data sources can be created through the API. "localInventoryDataSource": { # The local inventory data source type is only available for file inputs and can't be used to create API local inventory data sources. # The [local inventory](https://support.google.com/merchants/answer/7023001) data source. "contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the local inventory is provided. - "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). + "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). }, "merchantReviewDataSource": { # The merchant review data source. # The [merchant review](https://support.google.com/merchants/answer/7045996) data source. }, @@ -389,7 +389,7 @@

Method Details

"state": "A String", # The state of the destination. }, ], - "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. + "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). For more information about feed label, see [Create a primary data source for products](https://developers.google.com/merchant/api/guides/data-sources/api-sources#create-primary-data-source). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. }, "productReviewDataSource": { # The product review data source. # The [product review](https://support.google.com/merchants/answer/7045996) data source. }, @@ -399,11 +399,11 @@

Method Details

}, "regionalInventoryDataSource": { # The [regional inventory](https://support.google.com/merchants/answer/7439058) data source. "contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the regional inventory is provided. - "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the regional inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). + "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the regional inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). }, "supplementalProductDataSource": { # The [supplemental data source](https://developers.google.com/merchant/api/guides/data-sources/api-sources#link-supplemental-data-source) for local and online products. After creation,you should make sure to link the supplemental product data source into one or more primary product data sources. # The [supplemental data source](https://support.google.com/merchants/answer/7439058) for local and online products. "contentLanguage": "A String", # Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source. `feedLabel` and `contentLanguage` must be either both set or unset. The fields can only be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. - "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. + "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. "referencingPrimaryDataSources": [ # Output only. The (unordered and deduplicated) list of all primary data sources linked to this data source in either default or custom rules. Supplemental data source cannot be deleted before all links are removed. { # Data source reference can be used to manage related data sources within the data source service. "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` @@ -459,7 +459,7 @@

Method Details

"input": "A String", # Output only. Determines the type of input to the data source. Based on the input some settings might not work. Only generic data sources can be created through the API. "localInventoryDataSource": { # The local inventory data source type is only available for file inputs and can't be used to create API local inventory data sources. # The [local inventory](https://support.google.com/merchants/answer/7023001) data source. "contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the local inventory is provided. - "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). + "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). }, "merchantReviewDataSource": { # The merchant review data source. # The [merchant review](https://support.google.com/merchants/answer/7045996) data source. }, @@ -485,7 +485,7 @@

Method Details

"state": "A String", # The state of the destination. }, ], - "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. + "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). For more information about feed label, see [Create a primary data source for products](https://developers.google.com/merchant/api/guides/data-sources/api-sources#create-primary-data-source). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. }, "productReviewDataSource": { # The product review data source. # The [product review](https://support.google.com/merchants/answer/7045996) data source. }, @@ -495,11 +495,11 @@

Method Details

}, "regionalInventoryDataSource": { # The [regional inventory](https://support.google.com/merchants/answer/7439058) data source. "contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the regional inventory is provided. - "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the regional inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). + "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the regional inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). }, "supplementalProductDataSource": { # The [supplemental data source](https://developers.google.com/merchant/api/guides/data-sources/api-sources#link-supplemental-data-source) for local and online products. After creation,you should make sure to link the supplemental product data source into one or more primary product data sources. # The [supplemental data source](https://support.google.com/merchants/answer/7439058) for local and online products. "contentLanguage": "A String", # Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source. `feedLabel` and `contentLanguage` must be either both set or unset. The fields can only be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. - "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. + "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. "referencingPrimaryDataSources": [ # Output only. The (unordered and deduplicated) list of all primary data sources linked to this data source in either default or custom rules. Supplemental data source cannot be deleted before all links are removed. { # Data source reference can be used to manage related data sources within the data source service. "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` @@ -563,7 +563,7 @@

Method Details

"input": "A String", # Output only. Determines the type of input to the data source. Based on the input some settings might not work. Only generic data sources can be created through the API. "localInventoryDataSource": { # The local inventory data source type is only available for file inputs and can't be used to create API local inventory data sources. # The [local inventory](https://support.google.com/merchants/answer/7023001) data source. "contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the local inventory is provided. - "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). + "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). }, "merchantReviewDataSource": { # The merchant review data source. # The [merchant review](https://support.google.com/merchants/answer/7045996) data source. }, @@ -589,7 +589,7 @@

Method Details

"state": "A String", # The state of the destination. }, ], - "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. + "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). For more information about feed label, see [Create a primary data source for products](https://developers.google.com/merchant/api/guides/data-sources/api-sources#create-primary-data-source). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. }, "productReviewDataSource": { # The product review data source. # The [product review](https://support.google.com/merchants/answer/7045996) data source. }, @@ -599,11 +599,11 @@

Method Details

}, "regionalInventoryDataSource": { # The [regional inventory](https://support.google.com/merchants/answer/7439058) data source. "contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the regional inventory is provided. - "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the regional inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). + "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the regional inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). }, "supplementalProductDataSource": { # The [supplemental data source](https://developers.google.com/merchant/api/guides/data-sources/api-sources#link-supplemental-data-source) for local and online products. After creation,you should make sure to link the supplemental product data source into one or more primary product data sources. # The [supplemental data source](https://support.google.com/merchants/answer/7439058) for local and online products. "contentLanguage": "A String", # Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source. `feedLabel` and `contentLanguage` must be either both set or unset. The fields can only be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. - "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. + "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. "referencingPrimaryDataSources": [ # Output only. The (unordered and deduplicated) list of all primary data sources linked to this data source in either default or custom rules. Supplemental data source cannot be deleted before all links are removed. { # Data source reference can be used to manage related data sources within the data source service. "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` @@ -649,7 +649,7 @@

Method Details

"input": "A String", # Output only. Determines the type of input to the data source. Based on the input some settings might not work. Only generic data sources can be created through the API. "localInventoryDataSource": { # The local inventory data source type is only available for file inputs and can't be used to create API local inventory data sources. # The [local inventory](https://support.google.com/merchants/answer/7023001) data source. "contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the local inventory is provided. - "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). + "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). }, "merchantReviewDataSource": { # The merchant review data source. # The [merchant review](https://support.google.com/merchants/answer/7045996) data source. }, @@ -675,7 +675,7 @@

Method Details

"state": "A String", # The state of the destination. }, ], - "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. + "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). For more information about feed label, see [Create a primary data source for products](https://developers.google.com/merchant/api/guides/data-sources/api-sources#create-primary-data-source). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. }, "productReviewDataSource": { # The product review data source. # The [product review](https://support.google.com/merchants/answer/7045996) data source. }, @@ -685,11 +685,11 @@

Method Details

}, "regionalInventoryDataSource": { # The [regional inventory](https://support.google.com/merchants/answer/7439058) data source. "contentLanguage": "A String", # Required. Immutable. The two-letter ISO 639-1 language of the items to which the regional inventory is provided. - "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the regional inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). + "feedLabel": "A String", # Required. Immutable. The feed label of the offers to which the regional inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). }, "supplementalProductDataSource": { # The [supplemental data source](https://developers.google.com/merchant/api/guides/data-sources/api-sources#link-supplemental-data-source) for local and online products. After creation,you should make sure to link the supplemental product data source into one or more primary product data sources. # The [supplemental data source](https://support.google.com/merchants/answer/7439058) for local and online products. "contentLanguage": "A String", # Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source. `feedLabel` and `contentLanguage` must be either both set or unset. The fields can only be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. - "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. + "feedLabel": "A String", # Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. "referencingPrimaryDataSources": [ # Output only. The (unordered and deduplicated) list of all primary data sources linked to this data source in either default or custom rules. Supplemental data source cannot be deleted before all links are removed. { # Data source reference can be used to manage related data sources within the data source service. "primaryDataSourceName": "A String", # Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}` diff --git a/docs/dyn/merchantapi_promotions_v1beta.accounts.promotions.html b/docs/dyn/merchantapi_promotions_v1beta.accounts.promotions.html index 92bc115337..94227698d9 100644 --- a/docs/dyn/merchantapi_promotions_v1beta.accounts.promotions.html +++ b/docs/dyn/merchantapi_promotions_v1beta.accounts.promotions.html @@ -112,67 +112,77 @@

Method Details

{ # Represents a promotion. See the following articles for more details. Required promotion input attributes to pass data validation checks are primarily defined below: * [Promotions data specification](https://support.google.com/merchants/answer/2906014) * [Local promotions data specification](https://support.google.com/merchants/answer/10146130) After inserting, updating a promotion input, it may take several minutes before the final promotion can be retrieved. "attributes": { # Attributes. # Optional. A list of promotion attributes. "audience": "A String", # Optional. This field defines the audience a promotion will be visible to. - "brandExclusion": [ # Optional. Product filter by [brand exclusion](https://support.google.com/merchants/answer/13861679?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC). + "brandExclusion": [ # Optional. Product filter by [brand exclusion](https://support.google.com/merchants/answer/13861679?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). "A String", ], - "brandInclusion": [ # Optional. Product filter by brand for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC). + "brandInclusion": [ # Optional. Product filter by brand for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). "A String", ], - "couponValueType": "A String", # Required. The [coupon value type] (https://support.google.com/merchants/answer/13861986?ref_topic=13773355&sjid=17642868584668136159-NC) attribute to signal the type of promotion that you are running. Depending on type of the selected coupon value [some attributes are required](https://support.google.com/merchants/answer/6393006?ref_topic=7322920). + "couponValueType": "A String", # Required. The [coupon value type] (https://support.google.com/merchants/answer/13861986?ref_topic=13773355) attribute to signal the type of promotion that you are running. Depending on type of the selected coupon value [some attributes are required](https://support.google.com/merchants/answer/6393006?ref_topic=7322920). "customRedemptionRestriction": "A String", # Optional. The custom redemption restriction for the promotion. If the `redemption_restriction` field is set to `CUSTOM`, this field must be set. - "eventApplicability": "A String", # Optional. Event applicability for this promotion. When present, this field indicates you are creating a [sales event](https://support.google.com/merchants/answer/15523289?hl=en&sjid=11099988466404504696-NC) and not a product promotion. Exactly one of `product_applicability` or `event_applicability` must be set. - "freeGiftDescription": "A String", # Optional. [Free gift description](https://support.google.com/merchants/answer/13847245?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. - "freeGiftItemId": "A String", # Optional. [Free gift item ID](https://support.google.com/merchants/answer/13857152?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. - "freeGiftValue": { # The price represented as a number and currency. # Optional. [Free gift value](https://support.google.com/merchants/answer/13844477?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. + "eventApplicability": "A String", # Optional. Event applicability for this promotion. When present, this field indicates you are creating a [sales event](https://support.google.com/merchants/answer/15523289) and not a product promotion. Exactly one of `product_applicability` or `event_applicability` must be set. + "freeGiftDescription": "A String", # Optional. [Free gift description](https://support.google.com/merchants/answer/13847245?ref_topic=13773355) for the promotion. + "freeGiftItemId": "A String", # Optional. [Free gift item ID](https://support.google.com/merchants/answer/13857152?ref_topic=13773355) for the promotion. + "freeGiftValue": { # The price represented as a number and currency. # Optional. [Free gift value](https://support.google.com/merchants/answer/13844477?ref_topic=13773355) for the promotion. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, - "genericRedemptionCode": "A String", # Optional. Generic redemption code for the promotion. To be used with the `offerType` field and must meet the [minimum requirements](https://support.google.com/merchants/answer/13837405?ref_topic=13773355&sjid=17642868584668136159-NC). + "genericRedemptionCode": "A String", # Optional. Generic redemption code for the promotion. To be used with the `offerType` field and must meet the [minimum requirements](https://support.google.com/merchants/answer/13837405?ref_topic=13773355). "getThisQuantityDiscounted": "A String", # Optional. The number of items discounted in the promotion. The attribute is set when `couponValueType` is equal to `buy_m_get_n_money_off` or `buy_m_get_n_percent_off`. - "googleProductCategories": [ # Optional. A list of Google product categories for this promotion. Set if `EventApplicability` is `SPECIFIC_CATEGORIES`. Up to 5 product categories can be specified. For more details on eligible values for product categories, checkout the `google_product_category` attribute in the [Promotion data specification](https://support.google.com/merchants/answer/2906014?hl=en). + "googleProductCategories": [ # Optional. A list of Google product categories for this promotion. Set if `EventApplicability` is `SPECIFIC_CATEGORIES`. Up to 5 product categories can be specified. For more details on eligible values for product categories, checkout the `google_product_category` attribute in the [Promotion data specification](https://support.google.com/merchants/answer/2906014). "A String", ], - "itemGroupIdExclusion": [ # Optional. Product filter by [item group ID](https://support.google.com/merchants/answer/13837298?ref_topic=13773355&sjid=17642868584668136159-NC). The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC). exclusion for the promotion. + "itemGroupIdExclusion": [ # Optional. Product filter by [item group ID](https://support.google.com/merchants/answer/13837298?ref_topic=13773355). The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). exclusion for the promotion. "A String", ], - "itemGroupIdInclusion": [ # Optional. Product filter by item group ID for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability [product_applicability] attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC). + "itemGroupIdInclusion": [ # Optional. Product filter by item group ID for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability [product_applicability] attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). "A String", ], - "itemIdExclusion": [ # Optional. Product filter by [item ID exclusion](https://support.google.com/merchants/answer/13863524?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC). + "itemIdExclusion": [ # Optional. Product filter by [item ID exclusion](https://support.google.com/merchants/answer/13863524?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). "A String", ], - "itemIdInclusion": [ # Optional. Product filter by [item ID](https://support.google.com/merchants/answer/13861565?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC). + "itemIdInclusion": [ # Optional. Product filter by [item ID](https://support.google.com/merchants/answer/13861565?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). "A String", ], - "limitQuantity": "A String", # Optional. [Maximum purchase quantity](https://support.google.com/merchants/answer/13861564?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. + "limitQuantity": "A String", # Optional. [Maximum purchase quantity](https://support.google.com/merchants/answer/13861564?ref_topic=13773355) for the promotion. "limitValue": { # The price represented as a number and currency. # Optional. [Maximum product price](https://support.google.com/merchants/answer/2906014) for promotion. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, - "longTitle": "A String", # Required. [Long title](https://support.google.com/merchants/answer/13838102?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. + "longTitle": "A String", # Required. [Long title](https://support.google.com/merchants/answer/13838102?ref_topic=13773355) for the promotion. "maxDiscountAmount": { # The price represented as a number and currency. # Optional. The maximum monetary discount a customer can receive for the promotion. This field is only supported with the `Percent off` coupon value type. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, - "minimumPurchaseAmount": { # The price represented as a number and currency. # Optional. [Minimum purchase amount](https://support.google.com/merchants/answer/13837705?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. + "maxMoneyOffAmount": { # The price represented as a number and currency. # Optional. Maximum money off amount for a promotion with `MONEY_OFF_RANGE` coupon value type. At least one of `min_money_off_amount` or `max_money_off_amount` must be present when the coupon value type is `MONEY_OFF_RANGE`. If neither is provided an `INVALID_PROMOTION_MISSING_BENEFIT_OR_RESTRICTION` error is returned. + "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). + "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). + }, + "maxPercentOff": "A String", # Optional. Maximum percent off for a promotion with `PERCENT_OFF_RANGE` coupon value type. At least one of `min_percent_off` or `max_percent_off` must be present when the coupon value type is `PERCENT_OFF_RANGE`. If neither is provided an `INVALID_PROMOTION_MISSING_BENEFIT_OR_RESTRICTION` error is returned. + "minMoneyOffAmount": { # The price represented as a number and currency. # Optional. Minimum money off amount for a promotion with `MONEY_OFF_RANGE` coupon value type. At least one of `min_money_off_amount` or `max_money_off_amount` must be present when the coupon value type is `MONEY_OFF_RANGE`. If neither is provided an `INVALID_PROMOTION_MISSING_BENEFIT_OR_RESTRICTION` error is returned. + "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). + "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). + }, + "minPercentOff": "A String", # Optional. Minimum percent off for a promotion with `PERCENT_OFF_RANGE` coupon value type. At least one of `min_percent_off` or `max_percent_off` must be present when the coupon value type is `PERCENT_OFF_RANGE`. If neither is provided an `INVALID_PROMOTION_MISSING_BENEFIT_OR_RESTRICTION` error is returned. + "minimumPurchaseAmount": { # The price represented as a number and currency. # Optional. [Minimum purchase amount](https://support.google.com/merchants/answer/13837705?ref_topic=13773355) for the promotion. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, "minimumPurchaseQuantity": "A String", - "moneyOffAmount": { # The price represented as a number and currency. # Optional. The [money off amount](https://support.google.com/merchants/answer/13838101?ref_topic=13773355&sjid=17642868584668136159-NC) offered in the promotion. + "moneyOffAmount": { # The price represented as a number and currency. # Optional. The [money off amount](https://support.google.com/merchants/answer/13838101?ref_topic=13773355) offered in the promotion. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, - "offerType": "A String", # Required. [Type](https://support.google.com/merchants/answer/13837405?ref_topic=13773355&sjid=17642868584668136159-NC) of the promotion. Use this attribute to indicate whether or not customers need a coupon code to redeem your promotion. + "offerType": "A String", # Required. [Type](https://support.google.com/merchants/answer/13837405?ref_topic=13773355) of the promotion. Use this attribute to indicate whether or not customers need a coupon code to redeem your promotion. "percentOff": "A String", # Optional. The [percentage discount](https://support.google.com/merchants/answer/13837404?sjid=17642868584668136159-NC) offered in the promotion. - "productApplicability": "A String", # Optional. Applicability of the promotion to either all products or [only specific products](https://support.google.com/merchants/answer/6396257?ref_topic=6396150&sjid=17642868584668136159-NC). Exactly one of `product_applicability` or `event_applicability` must be set. - "productTypeExclusion": [ # Optional. Product filter by [product type exclusion](https://support.google.com/merchants/answer/13863746?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC). + "productApplicability": "A String", # Optional. Applicability of the promotion to either all products or [only specific products](https://support.google.com/merchants/answer/6396257). Exactly one of `product_applicability` or `event_applicability` must be set. + "productTypeExclusion": [ # Optional. Product filter by [product type exclusion](https://support.google.com/merchants/answer/13863746?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). "A String", ], - "productTypeInclusion": [ # Optional. Product filter by product type for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC). + "productTypeInclusion": [ # Optional. Product filter by product type for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). "A String", ], - "promotionDestinations": [ # Required. The list of destinations (also known as [Marketing methods](https://support.google.com/merchants/answer/15130232)) where the promotion applies to. If you don't specify a destination by including a supported value in your data source, your promotion will display in Shopping ads and free listings by default. You may have previously submitted the following values as destinations for your products: Shopping Actions, Surfaces across Google, Local surfaces across Google. To represent these values use `FREE_LISTINGS`, `FREE_LOCAL_LISTINGS`, `LOCAL_INVENTORY_ADS`. For more details see [Promotion destination](https://support.google.com/merchants/answer/13837465?sjid=5155774230887277618-NC) + "promotionDestinations": [ # Required. The list of destinations (also known as [Marketing methods](https://support.google.com/merchants/answer/15130232)) where the promotion applies to. If you don't specify a destination by including a supported value in your data source, your promotion will display in Shopping ads and free listings by default. You may have previously submitted the following values as destinations for your products: Shopping Actions, Surfaces across Google, Local surfaces across Google. To represent these values use `FREE_LISTINGS`, `FREE_LOCAL_LISTINGS`, `LOCAL_INVENTORY_ADS`. For more details see [Promotion destination](https://support.google.com/merchants/answer/13837465) "A String", ], "promotionDisplayTimePeriod": { # 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. # Optional. `TimePeriod` representation of the promotion's display dates. This attribute specifies the date and time frame when the promotion will be live on Google.com and Shopping ads. If the display time period for promotion `promotion_display_time_period` attribute is not specified, the promotion effective time period `promotion_effective_time_period` determines the date and time frame when the promotion will be live on Google.com and Shopping ads. @@ -185,14 +195,14 @@

Method Details

}, "promotionUrl": "A String", # Optional. URL to the page on the merchant's site where the promotion shows. Local Inventory ads promotions throw an error if no `promotion_url` is included. URL is used to confirm that the promotion is valid and can be redeemed. "redemptionRestriction": "A String", # Optional. A restriction customers must meet before they can redeem the promotion. - "regionIdInclusion": [ # Optional. A list of [regions](https://support.google.com/merchants/answer/15406457?hl=en&sjid=8815806704218720187-NC#howregionswork) where the promotion is applicable. Must be set if `audience` is set to `LOCATION`. + "regionIdInclusion": [ # Optional. A list of [regions](https://support.google.com/merchants/answer/15406457?#howregionswork) where the promotion is applicable. Must be set if `audience` is set to `LOCATION`. "A String", ], "storeApplicability": "A String", # Optional. Whether the promotion applies to [all stores, or only specified stores](https://support.google.com/merchants/answer/13857563?sjid=17642868584668136159-NC). Local Inventory ads promotions throw an error if no store applicability is included. An `INVALID_ARGUMENT` error is thrown if `store_applicability` is set to `ALL_STORES` and `store_codes_inclusion` or `score_code_exclusion` is set to a value. - "storeCodesExclusion": [ # Optional. [Store codes to exclude](https://support.google.com/merchants/answer/13859586?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355&sjid=17642868584668136159-NC). + "storeCodesExclusion": [ # Optional. [Store codes to exclude](https://support.google.com/merchants/answer/13859586?ref_topic=13773355) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355). "A String", ], - "storeCodesInclusion": [ # Optional. [Store codes to include](https://support.google.com/merchants/answer/13857470?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355&sjid=17642868584668136159-NC). Store code (the store ID from your Business Profile) of the physical store the product is sold in. See the [Local product inventory data specification](https://support.google.com/merchants/answer/3061342) for more information. + "storeCodesInclusion": [ # Optional. [Store codes to include](https://support.google.com/merchants/answer/13857470?ref_topic=13773355) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355). Store code (the store ID from your Business Profile) of the physical store the product is sold in. See the [Local product inventory data specification](https://support.google.com/merchants/answer/3061342) for more information. "A String", ], }, @@ -256,67 +266,77 @@

Method Details

"promotion": { # Represents a promotion. See the following articles for more details. Required promotion input attributes to pass data validation checks are primarily defined below: * [Promotions data specification](https://support.google.com/merchants/answer/2906014) * [Local promotions data specification](https://support.google.com/merchants/answer/10146130) After inserting, updating a promotion input, it may take several minutes before the final promotion can be retrieved. # Required. The promotion to insert. "attributes": { # Attributes. # Optional. A list of promotion attributes. "audience": "A String", # Optional. This field defines the audience a promotion will be visible to. - "brandExclusion": [ # Optional. Product filter by [brand exclusion](https://support.google.com/merchants/answer/13861679?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC). + "brandExclusion": [ # Optional. Product filter by [brand exclusion](https://support.google.com/merchants/answer/13861679?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). "A String", ], - "brandInclusion": [ # Optional. Product filter by brand for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC). + "brandInclusion": [ # Optional. Product filter by brand for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). "A String", ], - "couponValueType": "A String", # Required. The [coupon value type] (https://support.google.com/merchants/answer/13861986?ref_topic=13773355&sjid=17642868584668136159-NC) attribute to signal the type of promotion that you are running. Depending on type of the selected coupon value [some attributes are required](https://support.google.com/merchants/answer/6393006?ref_topic=7322920). + "couponValueType": "A String", # Required. The [coupon value type] (https://support.google.com/merchants/answer/13861986?ref_topic=13773355) attribute to signal the type of promotion that you are running. Depending on type of the selected coupon value [some attributes are required](https://support.google.com/merchants/answer/6393006?ref_topic=7322920). "customRedemptionRestriction": "A String", # Optional. The custom redemption restriction for the promotion. If the `redemption_restriction` field is set to `CUSTOM`, this field must be set. - "eventApplicability": "A String", # Optional. Event applicability for this promotion. When present, this field indicates you are creating a [sales event](https://support.google.com/merchants/answer/15523289?hl=en&sjid=11099988466404504696-NC) and not a product promotion. Exactly one of `product_applicability` or `event_applicability` must be set. - "freeGiftDescription": "A String", # Optional. [Free gift description](https://support.google.com/merchants/answer/13847245?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. - "freeGiftItemId": "A String", # Optional. [Free gift item ID](https://support.google.com/merchants/answer/13857152?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. - "freeGiftValue": { # The price represented as a number and currency. # Optional. [Free gift value](https://support.google.com/merchants/answer/13844477?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. + "eventApplicability": "A String", # Optional. Event applicability for this promotion. When present, this field indicates you are creating a [sales event](https://support.google.com/merchants/answer/15523289) and not a product promotion. Exactly one of `product_applicability` or `event_applicability` must be set. + "freeGiftDescription": "A String", # Optional. [Free gift description](https://support.google.com/merchants/answer/13847245?ref_topic=13773355) for the promotion. + "freeGiftItemId": "A String", # Optional. [Free gift item ID](https://support.google.com/merchants/answer/13857152?ref_topic=13773355) for the promotion. + "freeGiftValue": { # The price represented as a number and currency. # Optional. [Free gift value](https://support.google.com/merchants/answer/13844477?ref_topic=13773355) for the promotion. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, - "genericRedemptionCode": "A String", # Optional. Generic redemption code for the promotion. To be used with the `offerType` field and must meet the [minimum requirements](https://support.google.com/merchants/answer/13837405?ref_topic=13773355&sjid=17642868584668136159-NC). + "genericRedemptionCode": "A String", # Optional. Generic redemption code for the promotion. To be used with the `offerType` field and must meet the [minimum requirements](https://support.google.com/merchants/answer/13837405?ref_topic=13773355). "getThisQuantityDiscounted": "A String", # Optional. The number of items discounted in the promotion. The attribute is set when `couponValueType` is equal to `buy_m_get_n_money_off` or `buy_m_get_n_percent_off`. - "googleProductCategories": [ # Optional. A list of Google product categories for this promotion. Set if `EventApplicability` is `SPECIFIC_CATEGORIES`. Up to 5 product categories can be specified. For more details on eligible values for product categories, checkout the `google_product_category` attribute in the [Promotion data specification](https://support.google.com/merchants/answer/2906014?hl=en). + "googleProductCategories": [ # Optional. A list of Google product categories for this promotion. Set if `EventApplicability` is `SPECIFIC_CATEGORIES`. Up to 5 product categories can be specified. For more details on eligible values for product categories, checkout the `google_product_category` attribute in the [Promotion data specification](https://support.google.com/merchants/answer/2906014). "A String", ], - "itemGroupIdExclusion": [ # Optional. Product filter by [item group ID](https://support.google.com/merchants/answer/13837298?ref_topic=13773355&sjid=17642868584668136159-NC). The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC). exclusion for the promotion. + "itemGroupIdExclusion": [ # Optional. Product filter by [item group ID](https://support.google.com/merchants/answer/13837298?ref_topic=13773355). The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). exclusion for the promotion. "A String", ], - "itemGroupIdInclusion": [ # Optional. Product filter by item group ID for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability [product_applicability] attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC). + "itemGroupIdInclusion": [ # Optional. Product filter by item group ID for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability [product_applicability] attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). "A String", ], - "itemIdExclusion": [ # Optional. Product filter by [item ID exclusion](https://support.google.com/merchants/answer/13863524?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC). + "itemIdExclusion": [ # Optional. Product filter by [item ID exclusion](https://support.google.com/merchants/answer/13863524?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). "A String", ], - "itemIdInclusion": [ # Optional. Product filter by [item ID](https://support.google.com/merchants/answer/13861565?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC). + "itemIdInclusion": [ # Optional. Product filter by [item ID](https://support.google.com/merchants/answer/13861565?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). "A String", ], - "limitQuantity": "A String", # Optional. [Maximum purchase quantity](https://support.google.com/merchants/answer/13861564?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. + "limitQuantity": "A String", # Optional. [Maximum purchase quantity](https://support.google.com/merchants/answer/13861564?ref_topic=13773355) for the promotion. "limitValue": { # The price represented as a number and currency. # Optional. [Maximum product price](https://support.google.com/merchants/answer/2906014) for promotion. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, - "longTitle": "A String", # Required. [Long title](https://support.google.com/merchants/answer/13838102?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. + "longTitle": "A String", # Required. [Long title](https://support.google.com/merchants/answer/13838102?ref_topic=13773355) for the promotion. "maxDiscountAmount": { # The price represented as a number and currency. # Optional. The maximum monetary discount a customer can receive for the promotion. This field is only supported with the `Percent off` coupon value type. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, - "minimumPurchaseAmount": { # The price represented as a number and currency. # Optional. [Minimum purchase amount](https://support.google.com/merchants/answer/13837705?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. + "maxMoneyOffAmount": { # The price represented as a number and currency. # Optional. Maximum money off amount for a promotion with `MONEY_OFF_RANGE` coupon value type. At least one of `min_money_off_amount` or `max_money_off_amount` must be present when the coupon value type is `MONEY_OFF_RANGE`. If neither is provided an `INVALID_PROMOTION_MISSING_BENEFIT_OR_RESTRICTION` error is returned. + "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). + "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). + }, + "maxPercentOff": "A String", # Optional. Maximum percent off for a promotion with `PERCENT_OFF_RANGE` coupon value type. At least one of `min_percent_off` or `max_percent_off` must be present when the coupon value type is `PERCENT_OFF_RANGE`. If neither is provided an `INVALID_PROMOTION_MISSING_BENEFIT_OR_RESTRICTION` error is returned. + "minMoneyOffAmount": { # The price represented as a number and currency. # Optional. Minimum money off amount for a promotion with `MONEY_OFF_RANGE` coupon value type. At least one of `min_money_off_amount` or `max_money_off_amount` must be present when the coupon value type is `MONEY_OFF_RANGE`. If neither is provided an `INVALID_PROMOTION_MISSING_BENEFIT_OR_RESTRICTION` error is returned. + "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). + "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). + }, + "minPercentOff": "A String", # Optional. Minimum percent off for a promotion with `PERCENT_OFF_RANGE` coupon value type. At least one of `min_percent_off` or `max_percent_off` must be present when the coupon value type is `PERCENT_OFF_RANGE`. If neither is provided an `INVALID_PROMOTION_MISSING_BENEFIT_OR_RESTRICTION` error is returned. + "minimumPurchaseAmount": { # The price represented as a number and currency. # Optional. [Minimum purchase amount](https://support.google.com/merchants/answer/13837705?ref_topic=13773355) for the promotion. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, "minimumPurchaseQuantity": "A String", - "moneyOffAmount": { # The price represented as a number and currency. # Optional. The [money off amount](https://support.google.com/merchants/answer/13838101?ref_topic=13773355&sjid=17642868584668136159-NC) offered in the promotion. + "moneyOffAmount": { # The price represented as a number and currency. # Optional. The [money off amount](https://support.google.com/merchants/answer/13838101?ref_topic=13773355) offered in the promotion. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, - "offerType": "A String", # Required. [Type](https://support.google.com/merchants/answer/13837405?ref_topic=13773355&sjid=17642868584668136159-NC) of the promotion. Use this attribute to indicate whether or not customers need a coupon code to redeem your promotion. + "offerType": "A String", # Required. [Type](https://support.google.com/merchants/answer/13837405?ref_topic=13773355) of the promotion. Use this attribute to indicate whether or not customers need a coupon code to redeem your promotion. "percentOff": "A String", # Optional. The [percentage discount](https://support.google.com/merchants/answer/13837404?sjid=17642868584668136159-NC) offered in the promotion. - "productApplicability": "A String", # Optional. Applicability of the promotion to either all products or [only specific products](https://support.google.com/merchants/answer/6396257?ref_topic=6396150&sjid=17642868584668136159-NC). Exactly one of `product_applicability` or `event_applicability` must be set. - "productTypeExclusion": [ # Optional. Product filter by [product type exclusion](https://support.google.com/merchants/answer/13863746?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC). + "productApplicability": "A String", # Optional. Applicability of the promotion to either all products or [only specific products](https://support.google.com/merchants/answer/6396257). Exactly one of `product_applicability` or `event_applicability` must be set. + "productTypeExclusion": [ # Optional. Product filter by [product type exclusion](https://support.google.com/merchants/answer/13863746?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). "A String", ], - "productTypeInclusion": [ # Optional. Product filter by product type for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC). + "productTypeInclusion": [ # Optional. Product filter by product type for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). "A String", ], - "promotionDestinations": [ # Required. The list of destinations (also known as [Marketing methods](https://support.google.com/merchants/answer/15130232)) where the promotion applies to. If you don't specify a destination by including a supported value in your data source, your promotion will display in Shopping ads and free listings by default. You may have previously submitted the following values as destinations for your products: Shopping Actions, Surfaces across Google, Local surfaces across Google. To represent these values use `FREE_LISTINGS`, `FREE_LOCAL_LISTINGS`, `LOCAL_INVENTORY_ADS`. For more details see [Promotion destination](https://support.google.com/merchants/answer/13837465?sjid=5155774230887277618-NC) + "promotionDestinations": [ # Required. The list of destinations (also known as [Marketing methods](https://support.google.com/merchants/answer/15130232)) where the promotion applies to. If you don't specify a destination by including a supported value in your data source, your promotion will display in Shopping ads and free listings by default. You may have previously submitted the following values as destinations for your products: Shopping Actions, Surfaces across Google, Local surfaces across Google. To represent these values use `FREE_LISTINGS`, `FREE_LOCAL_LISTINGS`, `LOCAL_INVENTORY_ADS`. For more details see [Promotion destination](https://support.google.com/merchants/answer/13837465) "A String", ], "promotionDisplayTimePeriod": { # 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. # Optional. `TimePeriod` representation of the promotion's display dates. This attribute specifies the date and time frame when the promotion will be live on Google.com and Shopping ads. If the display time period for promotion `promotion_display_time_period` attribute is not specified, the promotion effective time period `promotion_effective_time_period` determines the date and time frame when the promotion will be live on Google.com and Shopping ads. @@ -329,14 +349,14 @@

Method Details

}, "promotionUrl": "A String", # Optional. URL to the page on the merchant's site where the promotion shows. Local Inventory ads promotions throw an error if no `promotion_url` is included. URL is used to confirm that the promotion is valid and can be redeemed. "redemptionRestriction": "A String", # Optional. A restriction customers must meet before they can redeem the promotion. - "regionIdInclusion": [ # Optional. A list of [regions](https://support.google.com/merchants/answer/15406457?hl=en&sjid=8815806704218720187-NC#howregionswork) where the promotion is applicable. Must be set if `audience` is set to `LOCATION`. + "regionIdInclusion": [ # Optional. A list of [regions](https://support.google.com/merchants/answer/15406457?#howregionswork) where the promotion is applicable. Must be set if `audience` is set to `LOCATION`. "A String", ], "storeApplicability": "A String", # Optional. Whether the promotion applies to [all stores, or only specified stores](https://support.google.com/merchants/answer/13857563?sjid=17642868584668136159-NC). Local Inventory ads promotions throw an error if no store applicability is included. An `INVALID_ARGUMENT` error is thrown if `store_applicability` is set to `ALL_STORES` and `store_codes_inclusion` or `score_code_exclusion` is set to a value. - "storeCodesExclusion": [ # Optional. [Store codes to exclude](https://support.google.com/merchants/answer/13859586?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355&sjid=17642868584668136159-NC). + "storeCodesExclusion": [ # Optional. [Store codes to exclude](https://support.google.com/merchants/answer/13859586?ref_topic=13773355) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355). "A String", ], - "storeCodesInclusion": [ # Optional. [Store codes to include](https://support.google.com/merchants/answer/13857470?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355&sjid=17642868584668136159-NC). Store code (the store ID from your Business Profile) of the physical store the product is sold in. See the [Local product inventory data specification](https://support.google.com/merchants/answer/3061342) for more information. + "storeCodesInclusion": [ # Optional. [Store codes to include](https://support.google.com/merchants/answer/13857470?ref_topic=13773355) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355). Store code (the store ID from your Business Profile) of the physical store the product is sold in. See the [Local product inventory data specification](https://support.google.com/merchants/answer/3061342) for more information. "A String", ], }, @@ -397,67 +417,77 @@

Method Details

{ # Represents a promotion. See the following articles for more details. Required promotion input attributes to pass data validation checks are primarily defined below: * [Promotions data specification](https://support.google.com/merchants/answer/2906014) * [Local promotions data specification](https://support.google.com/merchants/answer/10146130) After inserting, updating a promotion input, it may take several minutes before the final promotion can be retrieved. "attributes": { # Attributes. # Optional. A list of promotion attributes. "audience": "A String", # Optional. This field defines the audience a promotion will be visible to. - "brandExclusion": [ # Optional. Product filter by [brand exclusion](https://support.google.com/merchants/answer/13861679?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC). + "brandExclusion": [ # Optional. Product filter by [brand exclusion](https://support.google.com/merchants/answer/13861679?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). "A String", ], - "brandInclusion": [ # Optional. Product filter by brand for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC). + "brandInclusion": [ # Optional. Product filter by brand for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). "A String", ], - "couponValueType": "A String", # Required. The [coupon value type] (https://support.google.com/merchants/answer/13861986?ref_topic=13773355&sjid=17642868584668136159-NC) attribute to signal the type of promotion that you are running. Depending on type of the selected coupon value [some attributes are required](https://support.google.com/merchants/answer/6393006?ref_topic=7322920). + "couponValueType": "A String", # Required. The [coupon value type] (https://support.google.com/merchants/answer/13861986?ref_topic=13773355) attribute to signal the type of promotion that you are running. Depending on type of the selected coupon value [some attributes are required](https://support.google.com/merchants/answer/6393006?ref_topic=7322920). "customRedemptionRestriction": "A String", # Optional. The custom redemption restriction for the promotion. If the `redemption_restriction` field is set to `CUSTOM`, this field must be set. - "eventApplicability": "A String", # Optional. Event applicability for this promotion. When present, this field indicates you are creating a [sales event](https://support.google.com/merchants/answer/15523289?hl=en&sjid=11099988466404504696-NC) and not a product promotion. Exactly one of `product_applicability` or `event_applicability` must be set. - "freeGiftDescription": "A String", # Optional. [Free gift description](https://support.google.com/merchants/answer/13847245?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. - "freeGiftItemId": "A String", # Optional. [Free gift item ID](https://support.google.com/merchants/answer/13857152?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. - "freeGiftValue": { # The price represented as a number and currency. # Optional. [Free gift value](https://support.google.com/merchants/answer/13844477?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. + "eventApplicability": "A String", # Optional. Event applicability for this promotion. When present, this field indicates you are creating a [sales event](https://support.google.com/merchants/answer/15523289) and not a product promotion. Exactly one of `product_applicability` or `event_applicability` must be set. + "freeGiftDescription": "A String", # Optional. [Free gift description](https://support.google.com/merchants/answer/13847245?ref_topic=13773355) for the promotion. + "freeGiftItemId": "A String", # Optional. [Free gift item ID](https://support.google.com/merchants/answer/13857152?ref_topic=13773355) for the promotion. + "freeGiftValue": { # The price represented as a number and currency. # Optional. [Free gift value](https://support.google.com/merchants/answer/13844477?ref_topic=13773355) for the promotion. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, - "genericRedemptionCode": "A String", # Optional. Generic redemption code for the promotion. To be used with the `offerType` field and must meet the [minimum requirements](https://support.google.com/merchants/answer/13837405?ref_topic=13773355&sjid=17642868584668136159-NC). + "genericRedemptionCode": "A String", # Optional. Generic redemption code for the promotion. To be used with the `offerType` field and must meet the [minimum requirements](https://support.google.com/merchants/answer/13837405?ref_topic=13773355). "getThisQuantityDiscounted": "A String", # Optional. The number of items discounted in the promotion. The attribute is set when `couponValueType` is equal to `buy_m_get_n_money_off` or `buy_m_get_n_percent_off`. - "googleProductCategories": [ # Optional. A list of Google product categories for this promotion. Set if `EventApplicability` is `SPECIFIC_CATEGORIES`. Up to 5 product categories can be specified. For more details on eligible values for product categories, checkout the `google_product_category` attribute in the [Promotion data specification](https://support.google.com/merchants/answer/2906014?hl=en). + "googleProductCategories": [ # Optional. A list of Google product categories for this promotion. Set if `EventApplicability` is `SPECIFIC_CATEGORIES`. Up to 5 product categories can be specified. For more details on eligible values for product categories, checkout the `google_product_category` attribute in the [Promotion data specification](https://support.google.com/merchants/answer/2906014). "A String", ], - "itemGroupIdExclusion": [ # Optional. Product filter by [item group ID](https://support.google.com/merchants/answer/13837298?ref_topic=13773355&sjid=17642868584668136159-NC). The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC). exclusion for the promotion. + "itemGroupIdExclusion": [ # Optional. Product filter by [item group ID](https://support.google.com/merchants/answer/13837298?ref_topic=13773355). The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). exclusion for the promotion. "A String", ], - "itemGroupIdInclusion": [ # Optional. Product filter by item group ID for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability [product_applicability] attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC). + "itemGroupIdInclusion": [ # Optional. Product filter by item group ID for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability [product_applicability] attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). "A String", ], - "itemIdExclusion": [ # Optional. Product filter by [item ID exclusion](https://support.google.com/merchants/answer/13863524?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC). + "itemIdExclusion": [ # Optional. Product filter by [item ID exclusion](https://support.google.com/merchants/answer/13863524?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). "A String", ], - "itemIdInclusion": [ # Optional. Product filter by [item ID](https://support.google.com/merchants/answer/13861565?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC). + "itemIdInclusion": [ # Optional. Product filter by [item ID](https://support.google.com/merchants/answer/13861565?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). "A String", ], - "limitQuantity": "A String", # Optional. [Maximum purchase quantity](https://support.google.com/merchants/answer/13861564?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. + "limitQuantity": "A String", # Optional. [Maximum purchase quantity](https://support.google.com/merchants/answer/13861564?ref_topic=13773355) for the promotion. "limitValue": { # The price represented as a number and currency. # Optional. [Maximum product price](https://support.google.com/merchants/answer/2906014) for promotion. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, - "longTitle": "A String", # Required. [Long title](https://support.google.com/merchants/answer/13838102?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. + "longTitle": "A String", # Required. [Long title](https://support.google.com/merchants/answer/13838102?ref_topic=13773355) for the promotion. "maxDiscountAmount": { # The price represented as a number and currency. # Optional. The maximum monetary discount a customer can receive for the promotion. This field is only supported with the `Percent off` coupon value type. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, - "minimumPurchaseAmount": { # The price represented as a number and currency. # Optional. [Minimum purchase amount](https://support.google.com/merchants/answer/13837705?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. + "maxMoneyOffAmount": { # The price represented as a number and currency. # Optional. Maximum money off amount for a promotion with `MONEY_OFF_RANGE` coupon value type. At least one of `min_money_off_amount` or `max_money_off_amount` must be present when the coupon value type is `MONEY_OFF_RANGE`. If neither is provided an `INVALID_PROMOTION_MISSING_BENEFIT_OR_RESTRICTION` error is returned. + "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). + "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). + }, + "maxPercentOff": "A String", # Optional. Maximum percent off for a promotion with `PERCENT_OFF_RANGE` coupon value type. At least one of `min_percent_off` or `max_percent_off` must be present when the coupon value type is `PERCENT_OFF_RANGE`. If neither is provided an `INVALID_PROMOTION_MISSING_BENEFIT_OR_RESTRICTION` error is returned. + "minMoneyOffAmount": { # The price represented as a number and currency. # Optional. Minimum money off amount for a promotion with `MONEY_OFF_RANGE` coupon value type. At least one of `min_money_off_amount` or `max_money_off_amount` must be present when the coupon value type is `MONEY_OFF_RANGE`. If neither is provided an `INVALID_PROMOTION_MISSING_BENEFIT_OR_RESTRICTION` error is returned. + "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). + "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). + }, + "minPercentOff": "A String", # Optional. Minimum percent off for a promotion with `PERCENT_OFF_RANGE` coupon value type. At least one of `min_percent_off` or `max_percent_off` must be present when the coupon value type is `PERCENT_OFF_RANGE`. If neither is provided an `INVALID_PROMOTION_MISSING_BENEFIT_OR_RESTRICTION` error is returned. + "minimumPurchaseAmount": { # The price represented as a number and currency. # Optional. [Minimum purchase amount](https://support.google.com/merchants/answer/13837705?ref_topic=13773355) for the promotion. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, "minimumPurchaseQuantity": "A String", - "moneyOffAmount": { # The price represented as a number and currency. # Optional. The [money off amount](https://support.google.com/merchants/answer/13838101?ref_topic=13773355&sjid=17642868584668136159-NC) offered in the promotion. + "moneyOffAmount": { # The price represented as a number and currency. # Optional. The [money off amount](https://support.google.com/merchants/answer/13838101?ref_topic=13773355) offered in the promotion. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, - "offerType": "A String", # Required. [Type](https://support.google.com/merchants/answer/13837405?ref_topic=13773355&sjid=17642868584668136159-NC) of the promotion. Use this attribute to indicate whether or not customers need a coupon code to redeem your promotion. + "offerType": "A String", # Required. [Type](https://support.google.com/merchants/answer/13837405?ref_topic=13773355) of the promotion. Use this attribute to indicate whether or not customers need a coupon code to redeem your promotion. "percentOff": "A String", # Optional. The [percentage discount](https://support.google.com/merchants/answer/13837404?sjid=17642868584668136159-NC) offered in the promotion. - "productApplicability": "A String", # Optional. Applicability of the promotion to either all products or [only specific products](https://support.google.com/merchants/answer/6396257?ref_topic=6396150&sjid=17642868584668136159-NC). Exactly one of `product_applicability` or `event_applicability` must be set. - "productTypeExclusion": [ # Optional. Product filter by [product type exclusion](https://support.google.com/merchants/answer/13863746?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC). + "productApplicability": "A String", # Optional. Applicability of the promotion to either all products or [only specific products](https://support.google.com/merchants/answer/6396257). Exactly one of `product_applicability` or `event_applicability` must be set. + "productTypeExclusion": [ # Optional. Product filter by [product type exclusion](https://support.google.com/merchants/answer/13863746?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). "A String", ], - "productTypeInclusion": [ # Optional. Product filter by product type for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC). + "productTypeInclusion": [ # Optional. Product filter by product type for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). "A String", ], - "promotionDestinations": [ # Required. The list of destinations (also known as [Marketing methods](https://support.google.com/merchants/answer/15130232)) where the promotion applies to. If you don't specify a destination by including a supported value in your data source, your promotion will display in Shopping ads and free listings by default. You may have previously submitted the following values as destinations for your products: Shopping Actions, Surfaces across Google, Local surfaces across Google. To represent these values use `FREE_LISTINGS`, `FREE_LOCAL_LISTINGS`, `LOCAL_INVENTORY_ADS`. For more details see [Promotion destination](https://support.google.com/merchants/answer/13837465?sjid=5155774230887277618-NC) + "promotionDestinations": [ # Required. The list of destinations (also known as [Marketing methods](https://support.google.com/merchants/answer/15130232)) where the promotion applies to. If you don't specify a destination by including a supported value in your data source, your promotion will display in Shopping ads and free listings by default. You may have previously submitted the following values as destinations for your products: Shopping Actions, Surfaces across Google, Local surfaces across Google. To represent these values use `FREE_LISTINGS`, `FREE_LOCAL_LISTINGS`, `LOCAL_INVENTORY_ADS`. For more details see [Promotion destination](https://support.google.com/merchants/answer/13837465) "A String", ], "promotionDisplayTimePeriod": { # 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. # Optional. `TimePeriod` representation of the promotion's display dates. This attribute specifies the date and time frame when the promotion will be live on Google.com and Shopping ads. If the display time period for promotion `promotion_display_time_period` attribute is not specified, the promotion effective time period `promotion_effective_time_period` determines the date and time frame when the promotion will be live on Google.com and Shopping ads. @@ -470,14 +500,14 @@

Method Details

}, "promotionUrl": "A String", # Optional. URL to the page on the merchant's site where the promotion shows. Local Inventory ads promotions throw an error if no `promotion_url` is included. URL is used to confirm that the promotion is valid and can be redeemed. "redemptionRestriction": "A String", # Optional. A restriction customers must meet before they can redeem the promotion. - "regionIdInclusion": [ # Optional. A list of [regions](https://support.google.com/merchants/answer/15406457?hl=en&sjid=8815806704218720187-NC#howregionswork) where the promotion is applicable. Must be set if `audience` is set to `LOCATION`. + "regionIdInclusion": [ # Optional. A list of [regions](https://support.google.com/merchants/answer/15406457?#howregionswork) where the promotion is applicable. Must be set if `audience` is set to `LOCATION`. "A String", ], "storeApplicability": "A String", # Optional. Whether the promotion applies to [all stores, or only specified stores](https://support.google.com/merchants/answer/13857563?sjid=17642868584668136159-NC). Local Inventory ads promotions throw an error if no store applicability is included. An `INVALID_ARGUMENT` error is thrown if `store_applicability` is set to `ALL_STORES` and `store_codes_inclusion` or `score_code_exclusion` is set to a value. - "storeCodesExclusion": [ # Optional. [Store codes to exclude](https://support.google.com/merchants/answer/13859586?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355&sjid=17642868584668136159-NC). + "storeCodesExclusion": [ # Optional. [Store codes to exclude](https://support.google.com/merchants/answer/13859586?ref_topic=13773355) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355). "A String", ], - "storeCodesInclusion": [ # Optional. [Store codes to include](https://support.google.com/merchants/answer/13857470?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355&sjid=17642868584668136159-NC). Store code (the store ID from your Business Profile) of the physical store the product is sold in. See the [Local product inventory data specification](https://support.google.com/merchants/answer/3061342) for more information. + "storeCodesInclusion": [ # Optional. [Store codes to include](https://support.google.com/merchants/answer/13857470?ref_topic=13773355) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355). Store code (the store ID from your Business Profile) of the physical store the product is sold in. See the [Local product inventory data specification](https://support.google.com/merchants/answer/3061342) for more information. "A String", ], }, @@ -549,67 +579,77 @@

Method Details

{ # Represents a promotion. See the following articles for more details. Required promotion input attributes to pass data validation checks are primarily defined below: * [Promotions data specification](https://support.google.com/merchants/answer/2906014) * [Local promotions data specification](https://support.google.com/merchants/answer/10146130) After inserting, updating a promotion input, it may take several minutes before the final promotion can be retrieved. "attributes": { # Attributes. # Optional. A list of promotion attributes. "audience": "A String", # Optional. This field defines the audience a promotion will be visible to. - "brandExclusion": [ # Optional. Product filter by [brand exclusion](https://support.google.com/merchants/answer/13861679?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC). + "brandExclusion": [ # Optional. Product filter by [brand exclusion](https://support.google.com/merchants/answer/13861679?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). "A String", ], - "brandInclusion": [ # Optional. Product filter by brand for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC). + "brandInclusion": [ # Optional. Product filter by brand for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). "A String", ], - "couponValueType": "A String", # Required. The [coupon value type] (https://support.google.com/merchants/answer/13861986?ref_topic=13773355&sjid=17642868584668136159-NC) attribute to signal the type of promotion that you are running. Depending on type of the selected coupon value [some attributes are required](https://support.google.com/merchants/answer/6393006?ref_topic=7322920). + "couponValueType": "A String", # Required. The [coupon value type] (https://support.google.com/merchants/answer/13861986?ref_topic=13773355) attribute to signal the type of promotion that you are running. Depending on type of the selected coupon value [some attributes are required](https://support.google.com/merchants/answer/6393006?ref_topic=7322920). "customRedemptionRestriction": "A String", # Optional. The custom redemption restriction for the promotion. If the `redemption_restriction` field is set to `CUSTOM`, this field must be set. - "eventApplicability": "A String", # Optional. Event applicability for this promotion. When present, this field indicates you are creating a [sales event](https://support.google.com/merchants/answer/15523289?hl=en&sjid=11099988466404504696-NC) and not a product promotion. Exactly one of `product_applicability` or `event_applicability` must be set. - "freeGiftDescription": "A String", # Optional. [Free gift description](https://support.google.com/merchants/answer/13847245?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. - "freeGiftItemId": "A String", # Optional. [Free gift item ID](https://support.google.com/merchants/answer/13857152?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. - "freeGiftValue": { # The price represented as a number and currency. # Optional. [Free gift value](https://support.google.com/merchants/answer/13844477?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. + "eventApplicability": "A String", # Optional. Event applicability for this promotion. When present, this field indicates you are creating a [sales event](https://support.google.com/merchants/answer/15523289) and not a product promotion. Exactly one of `product_applicability` or `event_applicability` must be set. + "freeGiftDescription": "A String", # Optional. [Free gift description](https://support.google.com/merchants/answer/13847245?ref_topic=13773355) for the promotion. + "freeGiftItemId": "A String", # Optional. [Free gift item ID](https://support.google.com/merchants/answer/13857152?ref_topic=13773355) for the promotion. + "freeGiftValue": { # The price represented as a number and currency. # Optional. [Free gift value](https://support.google.com/merchants/answer/13844477?ref_topic=13773355) for the promotion. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, - "genericRedemptionCode": "A String", # Optional. Generic redemption code for the promotion. To be used with the `offerType` field and must meet the [minimum requirements](https://support.google.com/merchants/answer/13837405?ref_topic=13773355&sjid=17642868584668136159-NC). + "genericRedemptionCode": "A String", # Optional. Generic redemption code for the promotion. To be used with the `offerType` field and must meet the [minimum requirements](https://support.google.com/merchants/answer/13837405?ref_topic=13773355). "getThisQuantityDiscounted": "A String", # Optional. The number of items discounted in the promotion. The attribute is set when `couponValueType` is equal to `buy_m_get_n_money_off` or `buy_m_get_n_percent_off`. - "googleProductCategories": [ # Optional. A list of Google product categories for this promotion. Set if `EventApplicability` is `SPECIFIC_CATEGORIES`. Up to 5 product categories can be specified. For more details on eligible values for product categories, checkout the `google_product_category` attribute in the [Promotion data specification](https://support.google.com/merchants/answer/2906014?hl=en). + "googleProductCategories": [ # Optional. A list of Google product categories for this promotion. Set if `EventApplicability` is `SPECIFIC_CATEGORIES`. Up to 5 product categories can be specified. For more details on eligible values for product categories, checkout the `google_product_category` attribute in the [Promotion data specification](https://support.google.com/merchants/answer/2906014). "A String", ], - "itemGroupIdExclusion": [ # Optional. Product filter by [item group ID](https://support.google.com/merchants/answer/13837298?ref_topic=13773355&sjid=17642868584668136159-NC). The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC). exclusion for the promotion. + "itemGroupIdExclusion": [ # Optional. Product filter by [item group ID](https://support.google.com/merchants/answer/13837298?ref_topic=13773355). The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). exclusion for the promotion. "A String", ], - "itemGroupIdInclusion": [ # Optional. Product filter by item group ID for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability [product_applicability] attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC). + "itemGroupIdInclusion": [ # Optional. Product filter by item group ID for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability [product_applicability] attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). "A String", ], - "itemIdExclusion": [ # Optional. Product filter by [item ID exclusion](https://support.google.com/merchants/answer/13863524?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC). + "itemIdExclusion": [ # Optional. Product filter by [item ID exclusion](https://support.google.com/merchants/answer/13863524?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). "A String", ], - "itemIdInclusion": [ # Optional. Product filter by [item ID](https://support.google.com/merchants/answer/13861565?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC). + "itemIdInclusion": [ # Optional. Product filter by [item ID](https://support.google.com/merchants/answer/13861565?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). "A String", ], - "limitQuantity": "A String", # Optional. [Maximum purchase quantity](https://support.google.com/merchants/answer/13861564?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. + "limitQuantity": "A String", # Optional. [Maximum purchase quantity](https://support.google.com/merchants/answer/13861564?ref_topic=13773355) for the promotion. "limitValue": { # The price represented as a number and currency. # Optional. [Maximum product price](https://support.google.com/merchants/answer/2906014) for promotion. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, - "longTitle": "A String", # Required. [Long title](https://support.google.com/merchants/answer/13838102?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. + "longTitle": "A String", # Required. [Long title](https://support.google.com/merchants/answer/13838102?ref_topic=13773355) for the promotion. "maxDiscountAmount": { # The price represented as a number and currency. # Optional. The maximum monetary discount a customer can receive for the promotion. This field is only supported with the `Percent off` coupon value type. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, - "minimumPurchaseAmount": { # The price represented as a number and currency. # Optional. [Minimum purchase amount](https://support.google.com/merchants/answer/13837705?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. + "maxMoneyOffAmount": { # The price represented as a number and currency. # Optional. Maximum money off amount for a promotion with `MONEY_OFF_RANGE` coupon value type. At least one of `min_money_off_amount` or `max_money_off_amount` must be present when the coupon value type is `MONEY_OFF_RANGE`. If neither is provided an `INVALID_PROMOTION_MISSING_BENEFIT_OR_RESTRICTION` error is returned. + "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). + "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). + }, + "maxPercentOff": "A String", # Optional. Maximum percent off for a promotion with `PERCENT_OFF_RANGE` coupon value type. At least one of `min_percent_off` or `max_percent_off` must be present when the coupon value type is `PERCENT_OFF_RANGE`. If neither is provided an `INVALID_PROMOTION_MISSING_BENEFIT_OR_RESTRICTION` error is returned. + "minMoneyOffAmount": { # The price represented as a number and currency. # Optional. Minimum money off amount for a promotion with `MONEY_OFF_RANGE` coupon value type. At least one of `min_money_off_amount` or `max_money_off_amount` must be present when the coupon value type is `MONEY_OFF_RANGE`. If neither is provided an `INVALID_PROMOTION_MISSING_BENEFIT_OR_RESTRICTION` error is returned. + "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). + "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). + }, + "minPercentOff": "A String", # Optional. Minimum percent off for a promotion with `PERCENT_OFF_RANGE` coupon value type. At least one of `min_percent_off` or `max_percent_off` must be present when the coupon value type is `PERCENT_OFF_RANGE`. If neither is provided an `INVALID_PROMOTION_MISSING_BENEFIT_OR_RESTRICTION` error is returned. + "minimumPurchaseAmount": { # The price represented as a number and currency. # Optional. [Minimum purchase amount](https://support.google.com/merchants/answer/13837705?ref_topic=13773355) for the promotion. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, "minimumPurchaseQuantity": "A String", - "moneyOffAmount": { # The price represented as a number and currency. # Optional. The [money off amount](https://support.google.com/merchants/answer/13838101?ref_topic=13773355&sjid=17642868584668136159-NC) offered in the promotion. + "moneyOffAmount": { # The price represented as a number and currency. # Optional. The [money off amount](https://support.google.com/merchants/answer/13838101?ref_topic=13773355) offered in the promotion. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, - "offerType": "A String", # Required. [Type](https://support.google.com/merchants/answer/13837405?ref_topic=13773355&sjid=17642868584668136159-NC) of the promotion. Use this attribute to indicate whether or not customers need a coupon code to redeem your promotion. + "offerType": "A String", # Required. [Type](https://support.google.com/merchants/answer/13837405?ref_topic=13773355) of the promotion. Use this attribute to indicate whether or not customers need a coupon code to redeem your promotion. "percentOff": "A String", # Optional. The [percentage discount](https://support.google.com/merchants/answer/13837404?sjid=17642868584668136159-NC) offered in the promotion. - "productApplicability": "A String", # Optional. Applicability of the promotion to either all products or [only specific products](https://support.google.com/merchants/answer/6396257?ref_topic=6396150&sjid=17642868584668136159-NC). Exactly one of `product_applicability` or `event_applicability` must be set. - "productTypeExclusion": [ # Optional. Product filter by [product type exclusion](https://support.google.com/merchants/answer/13863746?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC). + "productApplicability": "A String", # Optional. Applicability of the promotion to either all products or [only specific products](https://support.google.com/merchants/answer/6396257). Exactly one of `product_applicability` or `event_applicability` must be set. + "productTypeExclusion": [ # Optional. Product filter by [product type exclusion](https://support.google.com/merchants/answer/13863746?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). "A String", ], - "productTypeInclusion": [ # Optional. Product filter by product type for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC). + "productTypeInclusion": [ # Optional. Product filter by product type for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). "A String", ], - "promotionDestinations": [ # Required. The list of destinations (also known as [Marketing methods](https://support.google.com/merchants/answer/15130232)) where the promotion applies to. If you don't specify a destination by including a supported value in your data source, your promotion will display in Shopping ads and free listings by default. You may have previously submitted the following values as destinations for your products: Shopping Actions, Surfaces across Google, Local surfaces across Google. To represent these values use `FREE_LISTINGS`, `FREE_LOCAL_LISTINGS`, `LOCAL_INVENTORY_ADS`. For more details see [Promotion destination](https://support.google.com/merchants/answer/13837465?sjid=5155774230887277618-NC) + "promotionDestinations": [ # Required. The list of destinations (also known as [Marketing methods](https://support.google.com/merchants/answer/15130232)) where the promotion applies to. If you don't specify a destination by including a supported value in your data source, your promotion will display in Shopping ads and free listings by default. You may have previously submitted the following values as destinations for your products: Shopping Actions, Surfaces across Google, Local surfaces across Google. To represent these values use `FREE_LISTINGS`, `FREE_LOCAL_LISTINGS`, `LOCAL_INVENTORY_ADS`. For more details see [Promotion destination](https://support.google.com/merchants/answer/13837465) "A String", ], "promotionDisplayTimePeriod": { # 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. # Optional. `TimePeriod` representation of the promotion's display dates. This attribute specifies the date and time frame when the promotion will be live on Google.com and Shopping ads. If the display time period for promotion `promotion_display_time_period` attribute is not specified, the promotion effective time period `promotion_effective_time_period` determines the date and time frame when the promotion will be live on Google.com and Shopping ads. @@ -622,14 +662,14 @@

Method Details

}, "promotionUrl": "A String", # Optional. URL to the page on the merchant's site where the promotion shows. Local Inventory ads promotions throw an error if no `promotion_url` is included. URL is used to confirm that the promotion is valid and can be redeemed. "redemptionRestriction": "A String", # Optional. A restriction customers must meet before they can redeem the promotion. - "regionIdInclusion": [ # Optional. A list of [regions](https://support.google.com/merchants/answer/15406457?hl=en&sjid=8815806704218720187-NC#howregionswork) where the promotion is applicable. Must be set if `audience` is set to `LOCATION`. + "regionIdInclusion": [ # Optional. A list of [regions](https://support.google.com/merchants/answer/15406457?#howregionswork) where the promotion is applicable. Must be set if `audience` is set to `LOCATION`. "A String", ], "storeApplicability": "A String", # Optional. Whether the promotion applies to [all stores, or only specified stores](https://support.google.com/merchants/answer/13857563?sjid=17642868584668136159-NC). Local Inventory ads promotions throw an error if no store applicability is included. An `INVALID_ARGUMENT` error is thrown if `store_applicability` is set to `ALL_STORES` and `store_codes_inclusion` or `score_code_exclusion` is set to a value. - "storeCodesExclusion": [ # Optional. [Store codes to exclude](https://support.google.com/merchants/answer/13859586?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355&sjid=17642868584668136159-NC). + "storeCodesExclusion": [ # Optional. [Store codes to exclude](https://support.google.com/merchants/answer/13859586?ref_topic=13773355) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355). "A String", ], - "storeCodesInclusion": [ # Optional. [Store codes to include](https://support.google.com/merchants/answer/13857470?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355&sjid=17642868584668136159-NC). Store code (the store ID from your Business Profile) of the physical store the product is sold in. See the [Local product inventory data specification](https://support.google.com/merchants/answer/3061342) for more information. + "storeCodesInclusion": [ # Optional. [Store codes to include](https://support.google.com/merchants/answer/13857470?ref_topic=13773355) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355). Store code (the store ID from your Business Profile) of the physical store the product is sold in. See the [Local product inventory data specification](https://support.google.com/merchants/answer/3061342) for more information. "A String", ], }, diff --git a/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1.json index 7fc834994c..5ffd55a5f0 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1.json @@ -321,7 +321,7 @@ } } }, -"revision": "20260223", +"revision": "20260303", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "DataSource": { @@ -745,7 +745,7 @@ "type": "string" }, "feedLabel": { -"description": "Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels).", +"description": "Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-).", "type": "string" } }, @@ -784,7 +784,7 @@ "type": "array" }, "feedLabel": { -"description": "Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction.", +"description": "Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). For more information about feed label, see [Create a primary data source for products](https://developers.google.com/merchant/api/guides/data-sources/api-sources#create-primary-data-source). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction.", "type": "string" }, "legacyLocal": { @@ -976,7 +976,7 @@ false "type": "string" }, "feedLabel": { -"description": "Required. Immutable. The feed label of the offers to which the regional inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels).", +"description": "Required. Immutable. The feed label of the offers to which the regional inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-).", "type": "string" } }, @@ -991,7 +991,7 @@ false "type": "string" }, "feedLabel": { -"description": "Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction.", +"description": "Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction.", "type": "string" }, "referencingPrimaryDataSources": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json index 6b7c3aaa7f..28f028d2ed 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json @@ -321,7 +321,7 @@ } } }, -"revision": "20260223", +"revision": "20260303", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "DataSource": { @@ -745,7 +745,7 @@ "type": "string" }, "feedLabel": { -"description": "Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels).", +"description": "Required. Immutable. The feed label of the offers to which the local inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-).", "type": "string" } }, @@ -800,7 +800,7 @@ "type": "array" }, "feedLabel": { -"description": "Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction.", +"description": "Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). For more information about feed label, see [Create a primary data source for products](https://developers.google.com/merchant/api/guides/data-sources/api-sources#create-primary-data-source). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction.", "type": "string" } }, @@ -988,7 +988,7 @@ false "type": "string" }, "feedLabel": { -"description": "Required. Immutable. The feed label of the offers to which the regional inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels).", +"description": "Required. Immutable. The feed label of the offers to which the regional inventory is provided. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-).", "type": "string" } }, @@ -1003,7 +1003,7 @@ false "type": "string" }, "feedLabel": { -"description": "Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction.", +"description": "Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. The fields must be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction.", "type": "string" }, "referencingPrimaryDataSources": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.promotions_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.promotions_v1beta.json index f3f7eced25..df5081e2e8 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.promotions_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.promotions_v1beta.json @@ -203,7 +203,7 @@ } } }, -"revision": "20260224", +"revision": "20260228", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Attributes": { @@ -219,27 +219,27 @@ ], "enumDescriptions": [ "The promotion is not restricted to any audience and will be shown to all users. Default value.", -"The Promotion will be shown to new customers only. If this value is set, the `promotion_destinations` field in `Attributes` must include `SHOPPING_ADS`. Requests that do not satisfy this condition will be rejected. For more details, see [First order promotions](https://support.google.com/merchants/answer/16310477?hl=en-IE&sjid=513157547625651759-NC)", -"The Promotion will be shown to customer within a certain location. Applicable locations must be specified in the `region_id_inclusion` field and the `promotion_destinations` field must contain `FREE_LISTINGS`. For more details, see [Regional Promotions](https://support.google.com/merchants/answer/16700435?hl=en&sjid=8815806704218720187-NC)." +"The Promotion will be shown to new customers only. If this value is set, the `promotion_destinations` field in `Attributes` must include `SHOPPING_ADS`. Requests that do not satisfy this condition will be rejected. For more details, see [First order promotions](https://support.google.com/merchants/answer/16310477)", +"The Promotion will be shown to customer within a certain location. Applicable locations must be specified in the `region_id_inclusion` field and the `promotion_destinations` field must contain `FREE_LISTINGS`. For more details, see [Regional Promotions](https://support.google.com/merchants/answer/16700435)." ], "type": "string" }, "brandExclusion": { -"description": "Optional. Product filter by [brand exclusion](https://support.google.com/merchants/answer/13861679?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).", +"description": "Optional. Product filter by [brand exclusion](https://support.google.com/merchants/answer/13861679?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).", "items": { "type": "string" }, "type": "array" }, "brandInclusion": { -"description": "Optional. Product filter by brand for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).", +"description": "Optional. Product filter by brand for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).", "items": { "type": "string" }, "type": "array" }, "couponValueType": { -"description": "Required. The [coupon value type] (https://support.google.com/merchants/answer/13861986?ref_topic=13773355&sjid=17642868584668136159-NC) attribute to signal the type of promotion that you are running. Depending on type of the selected coupon value [some attributes are required](https://support.google.com/merchants/answer/6393006?ref_topic=7322920).", +"description": "Required. The [coupon value type] (https://support.google.com/merchants/answer/13861986?ref_topic=13773355) attribute to signal the type of promotion that you are running. Depending on type of the selected coupon value [some attributes are required](https://support.google.com/merchants/answer/6393006?ref_topic=7322920).", "enum": [ "COUPON_VALUE_TYPE_UNSPECIFIED", "MONEY_OFF", @@ -253,7 +253,9 @@ "FREE_GIFT_WITH_ITEM_ID", "FREE_SHIPPING_STANDARD", "FREE_SHIPPING_OVERNIGHT", -"FREE_SHIPPING_TWO_DAY" +"FREE_SHIPPING_TWO_DAY", +"MONEY_OFF_RANGE", +"PERCENT_OFF_RANGE" ], "enumDescriptions": [ "Indicates that the coupon value type is unspecified.", @@ -268,7 +270,9 @@ "Free gift with item ID.", "Standard free shipping coupon value type. Only available for online promotions.", "Overnight free shipping coupon value type. Only available for online promotions.", -"Two day free shipping coupon value type. Only available for online promotions." +"Two day free shipping coupon value type. Only available for online promotions.", +"Money off range coupon value type. This coupon value type is used exclusively for US-based sales events. At least one of `min_money_off_amount` or `max_money_off_amount` must be present.", +"Percent off range coupon value type. This coupon value type is exclusively used for US-based sale events. At least one of `min_percent_off` or `max_percent_off` must be present." ], "type": "string" }, @@ -277,7 +281,7 @@ "type": "string" }, "eventApplicability": { -"description": "Optional. Event applicability for this promotion. When present, this field indicates you are creating a [sales event](https://support.google.com/merchants/answer/15523289?hl=en&sjid=11099988466404504696-NC) and not a product promotion. Exactly one of `product_applicability` or `event_applicability` must be set.", +"description": "Optional. Event applicability for this promotion. When present, this field indicates you are creating a [sales event](https://support.google.com/merchants/answer/15523289) and not a product promotion. Exactly one of `product_applicability` or `event_applicability` must be set.", "enum": [ "EVENT_APPLICABILITY_UNSPECIFIED", "SITEWIDE", @@ -291,19 +295,19 @@ "type": "string" }, "freeGiftDescription": { -"description": "Optional. [Free gift description](https://support.google.com/merchants/answer/13847245?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion.", +"description": "Optional. [Free gift description](https://support.google.com/merchants/answer/13847245?ref_topic=13773355) for the promotion.", "type": "string" }, "freeGiftItemId": { -"description": "Optional. [Free gift item ID](https://support.google.com/merchants/answer/13857152?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion.", +"description": "Optional. [Free gift item ID](https://support.google.com/merchants/answer/13857152?ref_topic=13773355) for the promotion.", "type": "string" }, "freeGiftValue": { "$ref": "Price", -"description": "Optional. [Free gift value](https://support.google.com/merchants/answer/13844477?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion." +"description": "Optional. [Free gift value](https://support.google.com/merchants/answer/13844477?ref_topic=13773355) for the promotion." }, "genericRedemptionCode": { -"description": "Optional. Generic redemption code for the promotion. To be used with the `offerType` field and must meet the [minimum requirements](https://support.google.com/merchants/answer/13837405?ref_topic=13773355&sjid=17642868584668136159-NC).", +"description": "Optional. Generic redemption code for the promotion. To be used with the `offerType` field and must meet the [minimum requirements](https://support.google.com/merchants/answer/13837405?ref_topic=13773355).", "type": "string" }, "getThisQuantityDiscounted": { @@ -312,42 +316,42 @@ "type": "string" }, "googleProductCategories": { -"description": "Optional. A list of Google product categories for this promotion. Set if `EventApplicability` is `SPECIFIC_CATEGORIES`. Up to 5 product categories can be specified. For more details on eligible values for product categories, checkout the `google_product_category` attribute in the [Promotion data specification](https://support.google.com/merchants/answer/2906014?hl=en).", +"description": "Optional. A list of Google product categories for this promotion. Set if `EventApplicability` is `SPECIFIC_CATEGORIES`. Up to 5 product categories can be specified. For more details on eligible values for product categories, checkout the `google_product_category` attribute in the [Promotion data specification](https://support.google.com/merchants/answer/2906014).", "items": { "type": "string" }, "type": "array" }, "itemGroupIdExclusion": { -"description": "Optional. Product filter by [item group ID](https://support.google.com/merchants/answer/13837298?ref_topic=13773355&sjid=17642868584668136159-NC). The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC). exclusion for the promotion.", +"description": "Optional. Product filter by [item group ID](https://support.google.com/merchants/answer/13837298?ref_topic=13773355). The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). exclusion for the promotion.", "items": { "type": "string" }, "type": "array" }, "itemGroupIdInclusion": { -"description": "Optional. Product filter by item group ID for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability [product_applicability] attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).", +"description": "Optional. Product filter by item group ID for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability [product_applicability] attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).", "items": { "type": "string" }, "type": "array" }, "itemIdExclusion": { -"description": "Optional. Product filter by [item ID exclusion](https://support.google.com/merchants/answer/13863524?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).", +"description": "Optional. Product filter by [item ID exclusion](https://support.google.com/merchants/answer/13863524?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).", "items": { "type": "string" }, "type": "array" }, "itemIdInclusion": { -"description": "Optional. Product filter by [item ID](https://support.google.com/merchants/answer/13861565?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).", +"description": "Optional. Product filter by [item ID](https://support.google.com/merchants/answer/13861565?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).", "items": { "type": "string" }, "type": "array" }, "limitQuantity": { -"description": "Optional. [Maximum purchase quantity](https://support.google.com/merchants/answer/13861564?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion.", +"description": "Optional. [Maximum purchase quantity](https://support.google.com/merchants/answer/13861564?ref_topic=13773355) for the promotion.", "format": "int64", "type": "string" }, @@ -356,16 +360,34 @@ "description": "Optional. [Maximum product price](https://support.google.com/merchants/answer/2906014) for promotion." }, "longTitle": { -"description": "Required. [Long title](https://support.google.com/merchants/answer/13838102?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion.", +"description": "Required. [Long title](https://support.google.com/merchants/answer/13838102?ref_topic=13773355) for the promotion.", "type": "string" }, "maxDiscountAmount": { "$ref": "Price", "description": "Optional. The maximum monetary discount a customer can receive for the promotion. This field is only supported with the `Percent off` coupon value type." }, +"maxMoneyOffAmount": { +"$ref": "Price", +"description": "Optional. Maximum money off amount for a promotion with `MONEY_OFF_RANGE` coupon value type. At least one of `min_money_off_amount` or `max_money_off_amount` must be present when the coupon value type is `MONEY_OFF_RANGE`. If neither is provided an `INVALID_PROMOTION_MISSING_BENEFIT_OR_RESTRICTION` error is returned." +}, +"maxPercentOff": { +"description": "Optional. Maximum percent off for a promotion with `PERCENT_OFF_RANGE` coupon value type. At least one of `min_percent_off` or `max_percent_off` must be present when the coupon value type is `PERCENT_OFF_RANGE`. If neither is provided an `INVALID_PROMOTION_MISSING_BENEFIT_OR_RESTRICTION` error is returned.", +"format": "int64", +"type": "string" +}, +"minMoneyOffAmount": { +"$ref": "Price", +"description": "Optional. Minimum money off amount for a promotion with `MONEY_OFF_RANGE` coupon value type. At least one of `min_money_off_amount` or `max_money_off_amount` must be present when the coupon value type is `MONEY_OFF_RANGE`. If neither is provided an `INVALID_PROMOTION_MISSING_BENEFIT_OR_RESTRICTION` error is returned." +}, +"minPercentOff": { +"description": "Optional. Minimum percent off for a promotion with `PERCENT_OFF_RANGE` coupon value type. At least one of `min_percent_off` or `max_percent_off` must be present when the coupon value type is `PERCENT_OFF_RANGE`. If neither is provided an `INVALID_PROMOTION_MISSING_BENEFIT_OR_RESTRICTION` error is returned.", +"format": "int64", +"type": "string" +}, "minimumPurchaseAmount": { "$ref": "Price", -"description": "Optional. [Minimum purchase amount](https://support.google.com/merchants/answer/13837705?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion." +"description": "Optional. [Minimum purchase amount](https://support.google.com/merchants/answer/13837705?ref_topic=13773355) for the promotion." }, "minimumPurchaseQuantity": { "format": "int64", @@ -373,10 +395,10 @@ }, "moneyOffAmount": { "$ref": "Price", -"description": "Optional. The [money off amount](https://support.google.com/merchants/answer/13838101?ref_topic=13773355&sjid=17642868584668136159-NC) offered in the promotion." +"description": "Optional. The [money off amount](https://support.google.com/merchants/answer/13838101?ref_topic=13773355) offered in the promotion." }, "offerType": { -"description": "Required. [Type](https://support.google.com/merchants/answer/13837405?ref_topic=13773355&sjid=17642868584668136159-NC) of the promotion. Use this attribute to indicate whether or not customers need a coupon code to redeem your promotion.", +"description": "Required. [Type](https://support.google.com/merchants/answer/13837405?ref_topic=13773355) of the promotion. Use this attribute to indicate whether or not customers need a coupon code to redeem your promotion.", "enum": [ "OFFER_TYPE_UNSPECIFIED", "NO_CODE", @@ -395,7 +417,7 @@ "type": "string" }, "productApplicability": { -"description": "Optional. Applicability of the promotion to either all products or [only specific products](https://support.google.com/merchants/answer/6396257?ref_topic=6396150&sjid=17642868584668136159-NC). Exactly one of `product_applicability` or `event_applicability` must be set.", +"description": "Optional. Applicability of the promotion to either all products or [only specific products](https://support.google.com/merchants/answer/6396257). Exactly one of `product_applicability` or `event_applicability` must be set.", "enum": [ "PRODUCT_APPLICABILITY_UNSPECIFIED", "ALL_PRODUCTS", @@ -409,21 +431,21 @@ "type": "string" }, "productTypeExclusion": { -"description": "Optional. Product filter by [product type exclusion](https://support.google.com/merchants/answer/13863746?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).", +"description": "Optional. Product filter by [product type exclusion](https://support.google.com/merchants/answer/13863746?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).", "items": { "type": "string" }, "type": "array" }, "productTypeInclusion": { -"description": "Optional. Product filter by product type for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).", +"description": "Optional. Product filter by product type for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).", "items": { "type": "string" }, "type": "array" }, "promotionDestinations": { -"description": "Required. The list of destinations (also known as [Marketing methods](https://support.google.com/merchants/answer/15130232)) where the promotion applies to. If you don't specify a destination by including a supported value in your data source, your promotion will display in Shopping ads and free listings by default. You may have previously submitted the following values as destinations for your products: Shopping Actions, Surfaces across Google, Local surfaces across Google. To represent these values use `FREE_LISTINGS`, `FREE_LOCAL_LISTINGS`, `LOCAL_INVENTORY_ADS`. For more details see [Promotion destination](https://support.google.com/merchants/answer/13837465?sjid=5155774230887277618-NC)", +"description": "Required. The list of destinations (also known as [Marketing methods](https://support.google.com/merchants/answer/15130232)) where the promotion applies to. If you don't specify a destination by including a supported value in your data source, your promotion will display in Shopping ads and free listings by default. You may have previously submitted the following values as destinations for your products: Shopping Actions, Surfaces across Google, Local surfaces across Google. To represent these values use `FREE_LISTINGS`, `FREE_LOCAL_LISTINGS`, `LOCAL_INVENTORY_ADS`. For more details see [Promotion destination](https://support.google.com/merchants/answer/13837465)", "items": { "enum": [ "DESTINATION_ENUM_UNSPECIFIED", @@ -492,7 +514,7 @@ "type": "string" }, "regionIdInclusion": { -"description": "Optional. A list of [regions](https://support.google.com/merchants/answer/15406457?hl=en&sjid=8815806704218720187-NC#howregionswork) where the promotion is applicable. Must be set if `audience` is set to `LOCATION`.", +"description": "Optional. A list of [regions](https://support.google.com/merchants/answer/15406457?#howregionswork) where the promotion is applicable. Must be set if `audience` is set to `LOCATION`.", "items": { "type": "string" }, @@ -513,14 +535,14 @@ "type": "string" }, "storeCodesExclusion": { -"description": "Optional. [Store codes to exclude](https://support.google.com/merchants/answer/13859586?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355&sjid=17642868584668136159-NC).", +"description": "Optional. [Store codes to exclude](https://support.google.com/merchants/answer/13859586?ref_topic=13773355) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355).", "items": { "type": "string" }, "type": "array" }, "storeCodesInclusion": { -"description": "Optional. [Store codes to include](https://support.google.com/merchants/answer/13857470?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355&sjid=17642868584668136159-NC). Store code (the store ID from your Business Profile) of the physical store the product is sold in. See the [Local product inventory data specification](https://support.google.com/merchants/answer/3061342) for more information.", +"description": "Optional. [Store codes to include](https://support.google.com/merchants/answer/13857470?ref_topic=13773355) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355). Store code (the store ID from your Business Profile) of the physical store the product is sold in. See the [Local product inventory data specification](https://support.google.com/merchants/answer/3061342) for more information.", "items": { "type": "string" }, From 8f80001d00540f5121a706e3785df16d29d36b8f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 10 Mar 2026 07:24:06 +0000 Subject: [PATCH 20/31] feat(monitoring): update the api #### monitoring:v1 The following keys were deleted: - schemas.CoordinatedWidget (Total Keys: 4) - schemas.Widget.properties.coordinatedWidget.$ref (Total Keys: 1) --- .../monitoring_v1.projects.dashboards.html | 96 ------------------- .../documents/monitoring.v1.json | 21 +--- 2 files changed, 1 insertion(+), 116 deletions(-) diff --git a/docs/dyn/monitoring_v1.projects.dashboards.html b/docs/dyn/monitoring_v1.projects.dashboards.html index cf132afaaf..b2e2e2171a 100644 --- a/docs/dyn/monitoring_v1.projects.dashboards.html +++ b/docs/dyn/monitoring_v1.projects.dashboards.html @@ -141,10 +141,6 @@

Method Details

"collapsibleGroup": { # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. "collapsed": True or False, # The collapsed state of the widget on first page load. }, - "coordinatedWidget": { # A widget that contains two widget visualizations that are coordinated in display. Currently, we only support the primary widget of TimeSeriesTable with the secondary widget of XyChart. # A widget that contains two widget visualizations that are coordinated in display. - "primary": # Object with schema name: Widget # Required. The primary visualization. Must be set. Must contain a data source. - "secondary": # Object with schema name: Widget # Required. The secondary visualization. Must be set. Must contain a data source. - }, "errorReportingPanel": { # A widget that displays a list of error groups. # A widget that displays a list of error groups. "projectNames": [ # The resource name of the Google Cloud Platform project. Written as projects/{projectID} or projects/{projectNumber}, where {projectID} and {projectNumber} can be found in the Google Cloud console (https://support.google.com/cloud/answer/6158840).Examples: projects/my-project-123, projects/5551234. "A String", @@ -1014,10 +1010,6 @@

Method Details

"collapsibleGroup": { # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. "collapsed": True or False, # The collapsed state of the widget on first page load. }, - "coordinatedWidget": { # A widget that contains two widget visualizations that are coordinated in display. Currently, we only support the primary widget of TimeSeriesTable with the secondary widget of XyChart. # A widget that contains two widget visualizations that are coordinated in display. - "primary": # Object with schema name: Widget # Required. The primary visualization. Must be set. Must contain a data source. - "secondary": # Object with schema name: Widget # Required. The secondary visualization. Must be set. Must contain a data source. - }, "errorReportingPanel": { # A widget that displays a list of error groups. # A widget that displays a list of error groups. "projectNames": [ # The resource name of the Google Cloud Platform project. Written as projects/{projectID} or projects/{projectNumber}, where {projectID} and {projectNumber} can be found in the Google Cloud console (https://support.google.com/cloud/answer/6158840).Examples: projects/my-project-123, projects/5551234. "A String", @@ -1783,10 +1775,6 @@

Method Details

"collapsibleGroup": { # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. "collapsed": True or False, # The collapsed state of the widget on first page load. }, - "coordinatedWidget": { # A widget that contains two widget visualizations that are coordinated in display. Currently, we only support the primary widget of TimeSeriesTable with the secondary widget of XyChart. # A widget that contains two widget visualizations that are coordinated in display. - "primary": # Object with schema name: Widget # Required. The primary visualization. Must be set. Must contain a data source. - "secondary": # Object with schema name: Widget # Required. The secondary visualization. Must be set. Must contain a data source. - }, "errorReportingPanel": { # A widget that displays a list of error groups. # A widget that displays a list of error groups. "projectNames": [ # The resource name of the Google Cloud Platform project. Written as projects/{projectID} or projects/{projectNumber}, where {projectID} and {projectNumber} can be found in the Google Cloud console (https://support.google.com/cloud/answer/6158840).Examples: projects/my-project-123, projects/5551234. "A String", @@ -2554,10 +2542,6 @@

Method Details

"collapsibleGroup": { # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. "collapsed": True or False, # The collapsed state of the widget on first page load. }, - "coordinatedWidget": { # A widget that contains two widget visualizations that are coordinated in display. Currently, we only support the primary widget of TimeSeriesTable with the secondary widget of XyChart. # A widget that contains two widget visualizations that are coordinated in display. - "primary": # Object with schema name: Widget # Required. The primary visualization. Must be set. Must contain a data source. - "secondary": # Object with schema name: Widget # Required. The secondary visualization. Must be set. Must contain a data source. - }, "errorReportingPanel": { # A widget that displays a list of error groups. # A widget that displays a list of error groups. "projectNames": [ # The resource name of the Google Cloud Platform project. Written as projects/{projectID} or projects/{projectNumber}, where {projectID} and {projectNumber} can be found in the Google Cloud console (https://support.google.com/cloud/answer/6158840).Examples: projects/my-project-123, projects/5551234. "A String", @@ -3350,10 +3334,6 @@

Method Details

"collapsibleGroup": { # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. "collapsed": True or False, # The collapsed state of the widget on first page load. }, - "coordinatedWidget": { # A widget that contains two widget visualizations that are coordinated in display. Currently, we only support the primary widget of TimeSeriesTable with the secondary widget of XyChart. # A widget that contains two widget visualizations that are coordinated in display. - "primary": # Object with schema name: Widget # Required. The primary visualization. Must be set. Must contain a data source. - "secondary": # Object with schema name: Widget # Required. The secondary visualization. Must be set. Must contain a data source. - }, "errorReportingPanel": { # A widget that displays a list of error groups. # A widget that displays a list of error groups. "projectNames": [ # The resource name of the Google Cloud Platform project. Written as projects/{projectID} or projects/{projectNumber}, where {projectID} and {projectNumber} can be found in the Google Cloud console (https://support.google.com/cloud/answer/6158840).Examples: projects/my-project-123, projects/5551234. "A String", @@ -4223,10 +4203,6 @@

Method Details

"collapsibleGroup": { # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. "collapsed": True or False, # The collapsed state of the widget on first page load. }, - "coordinatedWidget": { # A widget that contains two widget visualizations that are coordinated in display. Currently, we only support the primary widget of TimeSeriesTable with the secondary widget of XyChart. # A widget that contains two widget visualizations that are coordinated in display. - "primary": # Object with schema name: Widget # Required. The primary visualization. Must be set. Must contain a data source. - "secondary": # Object with schema name: Widget # Required. The secondary visualization. Must be set. Must contain a data source. - }, "errorReportingPanel": { # A widget that displays a list of error groups. # A widget that displays a list of error groups. "projectNames": [ # The resource name of the Google Cloud Platform project. Written as projects/{projectID} or projects/{projectNumber}, where {projectID} and {projectNumber} can be found in the Google Cloud console (https://support.google.com/cloud/answer/6158840).Examples: projects/my-project-123, projects/5551234. "A String", @@ -4992,10 +4968,6 @@

Method Details

"collapsibleGroup": { # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. "collapsed": True or False, # The collapsed state of the widget on first page load. }, - "coordinatedWidget": { # A widget that contains two widget visualizations that are coordinated in display. Currently, we only support the primary widget of TimeSeriesTable with the secondary widget of XyChart. # A widget that contains two widget visualizations that are coordinated in display. - "primary": # Object with schema name: Widget # Required. The primary visualization. Must be set. Must contain a data source. - "secondary": # Object with schema name: Widget # Required. The secondary visualization. Must be set. Must contain a data source. - }, "errorReportingPanel": { # A widget that displays a list of error groups. # A widget that displays a list of error groups. "projectNames": [ # The resource name of the Google Cloud Platform project. Written as projects/{projectID} or projects/{projectNumber}, where {projectID} and {projectNumber} can be found in the Google Cloud console (https://support.google.com/cloud/answer/6158840).Examples: projects/my-project-123, projects/5551234. "A String", @@ -5763,10 +5735,6 @@

Method Details

"collapsibleGroup": { # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. "collapsed": True or False, # The collapsed state of the widget on first page load. }, - "coordinatedWidget": { # A widget that contains two widget visualizations that are coordinated in display. Currently, we only support the primary widget of TimeSeriesTable with the secondary widget of XyChart. # A widget that contains two widget visualizations that are coordinated in display. - "primary": # Object with schema name: Widget # Required. The primary visualization. Must be set. Must contain a data source. - "secondary": # Object with schema name: Widget # Required. The secondary visualization. Must be set. Must contain a data source. - }, "errorReportingPanel": { # A widget that displays a list of error groups. # A widget that displays a list of error groups. "projectNames": [ # The resource name of the Google Cloud Platform project. Written as projects/{projectID} or projects/{projectNumber}, where {projectID} and {projectNumber} can be found in the Google Cloud console (https://support.google.com/cloud/answer/6158840).Examples: projects/my-project-123, projects/5551234. "A String", @@ -6583,10 +6551,6 @@

Method Details

"collapsibleGroup": { # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. "collapsed": True or False, # The collapsed state of the widget on first page load. }, - "coordinatedWidget": { # A widget that contains two widget visualizations that are coordinated in display. Currently, we only support the primary widget of TimeSeriesTable with the secondary widget of XyChart. # A widget that contains two widget visualizations that are coordinated in display. - "primary": # Object with schema name: Widget # Required. The primary visualization. Must be set. Must contain a data source. - "secondary": # Object with schema name: Widget # Required. The secondary visualization. Must be set. Must contain a data source. - }, "errorReportingPanel": { # A widget that displays a list of error groups. # A widget that displays a list of error groups. "projectNames": [ # The resource name of the Google Cloud Platform project. Written as projects/{projectID} or projects/{projectNumber}, where {projectID} and {projectNumber} can be found in the Google Cloud console (https://support.google.com/cloud/answer/6158840).Examples: projects/my-project-123, projects/5551234. "A String", @@ -7456,10 +7420,6 @@

Method Details

"collapsibleGroup": { # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. "collapsed": True or False, # The collapsed state of the widget on first page load. }, - "coordinatedWidget": { # A widget that contains two widget visualizations that are coordinated in display. Currently, we only support the primary widget of TimeSeriesTable with the secondary widget of XyChart. # A widget that contains two widget visualizations that are coordinated in display. - "primary": # Object with schema name: Widget # Required. The primary visualization. Must be set. Must contain a data source. - "secondary": # Object with schema name: Widget # Required. The secondary visualization. Must be set. Must contain a data source. - }, "errorReportingPanel": { # A widget that displays a list of error groups. # A widget that displays a list of error groups. "projectNames": [ # The resource name of the Google Cloud Platform project. Written as projects/{projectID} or projects/{projectNumber}, where {projectID} and {projectNumber} can be found in the Google Cloud console (https://support.google.com/cloud/answer/6158840).Examples: projects/my-project-123, projects/5551234. "A String", @@ -8225,10 +8185,6 @@

Method Details

"collapsibleGroup": { # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. "collapsed": True or False, # The collapsed state of the widget on first page load. }, - "coordinatedWidget": { # A widget that contains two widget visualizations that are coordinated in display. Currently, we only support the primary widget of TimeSeriesTable with the secondary widget of XyChart. # A widget that contains two widget visualizations that are coordinated in display. - "primary": # Object with schema name: Widget # Required. The primary visualization. Must be set. Must contain a data source. - "secondary": # Object with schema name: Widget # Required. The secondary visualization. Must be set. Must contain a data source. - }, "errorReportingPanel": { # A widget that displays a list of error groups. # A widget that displays a list of error groups. "projectNames": [ # The resource name of the Google Cloud Platform project. Written as projects/{projectID} or projects/{projectNumber}, where {projectID} and {projectNumber} can be found in the Google Cloud console (https://support.google.com/cloud/answer/6158840).Examples: projects/my-project-123, projects/5551234. "A String", @@ -8996,10 +8952,6 @@

Method Details

"collapsibleGroup": { # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. "collapsed": True or False, # The collapsed state of the widget on first page load. }, - "coordinatedWidget": { # A widget that contains two widget visualizations that are coordinated in display. Currently, we only support the primary widget of TimeSeriesTable with the secondary widget of XyChart. # A widget that contains two widget visualizations that are coordinated in display. - "primary": # Object with schema name: Widget # Required. The primary visualization. Must be set. Must contain a data source. - "secondary": # Object with schema name: Widget # Required. The secondary visualization. Must be set. Must contain a data source. - }, "errorReportingPanel": { # A widget that displays a list of error groups. # A widget that displays a list of error groups. "projectNames": [ # The resource name of the Google Cloud Platform project. Written as projects/{projectID} or projects/{projectNumber}, where {projectID} and {projectNumber} can be found in the Google Cloud console (https://support.google.com/cloud/answer/6158840).Examples: projects/my-project-123, projects/5551234. "A String", @@ -9802,10 +9754,6 @@

Method Details

"collapsibleGroup": { # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. "collapsed": True or False, # The collapsed state of the widget on first page load. }, - "coordinatedWidget": { # A widget that contains two widget visualizations that are coordinated in display. Currently, we only support the primary widget of TimeSeriesTable with the secondary widget of XyChart. # A widget that contains two widget visualizations that are coordinated in display. - "primary": # Object with schema name: Widget # Required. The primary visualization. Must be set. Must contain a data source. - "secondary": # Object with schema name: Widget # Required. The secondary visualization. Must be set. Must contain a data source. - }, "errorReportingPanel": { # A widget that displays a list of error groups. # A widget that displays a list of error groups. "projectNames": [ # The resource name of the Google Cloud Platform project. Written as projects/{projectID} or projects/{projectNumber}, where {projectID} and {projectNumber} can be found in the Google Cloud console (https://support.google.com/cloud/answer/6158840).Examples: projects/my-project-123, projects/5551234. "A String", @@ -10675,10 +10623,6 @@

Method Details

"collapsibleGroup": { # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. "collapsed": True or False, # The collapsed state of the widget on first page load. }, - "coordinatedWidget": { # A widget that contains two widget visualizations that are coordinated in display. Currently, we only support the primary widget of TimeSeriesTable with the secondary widget of XyChart. # A widget that contains two widget visualizations that are coordinated in display. - "primary": # Object with schema name: Widget # Required. The primary visualization. Must be set. Must contain a data source. - "secondary": # Object with schema name: Widget # Required. The secondary visualization. Must be set. Must contain a data source. - }, "errorReportingPanel": { # A widget that displays a list of error groups. # A widget that displays a list of error groups. "projectNames": [ # The resource name of the Google Cloud Platform project. Written as projects/{projectID} or projects/{projectNumber}, where {projectID} and {projectNumber} can be found in the Google Cloud console (https://support.google.com/cloud/answer/6158840).Examples: projects/my-project-123, projects/5551234. "A String", @@ -11444,10 +11388,6 @@

Method Details

"collapsibleGroup": { # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. "collapsed": True or False, # The collapsed state of the widget on first page load. }, - "coordinatedWidget": { # A widget that contains two widget visualizations that are coordinated in display. Currently, we only support the primary widget of TimeSeriesTable with the secondary widget of XyChart. # A widget that contains two widget visualizations that are coordinated in display. - "primary": # Object with schema name: Widget # Required. The primary visualization. Must be set. Must contain a data source. - "secondary": # Object with schema name: Widget # Required. The secondary visualization. Must be set. Must contain a data source. - }, "errorReportingPanel": { # A widget that displays a list of error groups. # A widget that displays a list of error groups. "projectNames": [ # The resource name of the Google Cloud Platform project. Written as projects/{projectID} or projects/{projectNumber}, where {projectID} and {projectNumber} can be found in the Google Cloud console (https://support.google.com/cloud/answer/6158840).Examples: projects/my-project-123, projects/5551234. "A String", @@ -12215,10 +12155,6 @@

Method Details

"collapsibleGroup": { # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. "collapsed": True or False, # The collapsed state of the widget on first page load. }, - "coordinatedWidget": { # A widget that contains two widget visualizations that are coordinated in display. Currently, we only support the primary widget of TimeSeriesTable with the secondary widget of XyChart. # A widget that contains two widget visualizations that are coordinated in display. - "primary": # Object with schema name: Widget # Required. The primary visualization. Must be set. Must contain a data source. - "secondary": # Object with schema name: Widget # Required. The secondary visualization. Must be set. Must contain a data source. - }, "errorReportingPanel": { # A widget that displays a list of error groups. # A widget that displays a list of error groups. "projectNames": [ # The resource name of the Google Cloud Platform project. Written as projects/{projectID} or projects/{projectNumber}, where {projectID} and {projectNumber} can be found in the Google Cloud console (https://support.google.com/cloud/answer/6158840).Examples: projects/my-project-123, projects/5551234. "A String", @@ -13029,10 +12965,6 @@

Method Details

"collapsibleGroup": { # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. "collapsed": True or False, # The collapsed state of the widget on first page load. }, - "coordinatedWidget": { # A widget that contains two widget visualizations that are coordinated in display. Currently, we only support the primary widget of TimeSeriesTable with the secondary widget of XyChart. # A widget that contains two widget visualizations that are coordinated in display. - "primary": # Object with schema name: Widget # Required. The primary visualization. Must be set. Must contain a data source. - "secondary": # Object with schema name: Widget # Required. The secondary visualization. Must be set. Must contain a data source. - }, "errorReportingPanel": { # A widget that displays a list of error groups. # A widget that displays a list of error groups. "projectNames": [ # The resource name of the Google Cloud Platform project. Written as projects/{projectID} or projects/{projectNumber}, where {projectID} and {projectNumber} can be found in the Google Cloud console (https://support.google.com/cloud/answer/6158840).Examples: projects/my-project-123, projects/5551234. "A String", @@ -13902,10 +13834,6 @@

Method Details

"collapsibleGroup": { # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. "collapsed": True or False, # The collapsed state of the widget on first page load. }, - "coordinatedWidget": { # A widget that contains two widget visualizations that are coordinated in display. Currently, we only support the primary widget of TimeSeriesTable with the secondary widget of XyChart. # A widget that contains two widget visualizations that are coordinated in display. - "primary": # Object with schema name: Widget # Required. The primary visualization. Must be set. Must contain a data source. - "secondary": # Object with schema name: Widget # Required. The secondary visualization. Must be set. Must contain a data source. - }, "errorReportingPanel": { # A widget that displays a list of error groups. # A widget that displays a list of error groups. "projectNames": [ # The resource name of the Google Cloud Platform project. Written as projects/{projectID} or projects/{projectNumber}, where {projectID} and {projectNumber} can be found in the Google Cloud console (https://support.google.com/cloud/answer/6158840).Examples: projects/my-project-123, projects/5551234. "A String", @@ -14671,10 +14599,6 @@

Method Details

"collapsibleGroup": { # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. "collapsed": True or False, # The collapsed state of the widget on first page load. }, - "coordinatedWidget": { # A widget that contains two widget visualizations that are coordinated in display. Currently, we only support the primary widget of TimeSeriesTable with the secondary widget of XyChart. # A widget that contains two widget visualizations that are coordinated in display. - "primary": # Object with schema name: Widget # Required. The primary visualization. Must be set. Must contain a data source. - "secondary": # Object with schema name: Widget # Required. The secondary visualization. Must be set. Must contain a data source. - }, "errorReportingPanel": { # A widget that displays a list of error groups. # A widget that displays a list of error groups. "projectNames": [ # The resource name of the Google Cloud Platform project. Written as projects/{projectID} or projects/{projectNumber}, where {projectID} and {projectNumber} can be found in the Google Cloud console (https://support.google.com/cloud/answer/6158840).Examples: projects/my-project-123, projects/5551234. "A String", @@ -15442,10 +15366,6 @@

Method Details

"collapsibleGroup": { # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. "collapsed": True or False, # The collapsed state of the widget on first page load. }, - "coordinatedWidget": { # A widget that contains two widget visualizations that are coordinated in display. Currently, we only support the primary widget of TimeSeriesTable with the secondary widget of XyChart. # A widget that contains two widget visualizations that are coordinated in display. - "primary": # Object with schema name: Widget # Required. The primary visualization. Must be set. Must contain a data source. - "secondary": # Object with schema name: Widget # Required. The secondary visualization. Must be set. Must contain a data source. - }, "errorReportingPanel": { # A widget that displays a list of error groups. # A widget that displays a list of error groups. "projectNames": [ # The resource name of the Google Cloud Platform project. Written as projects/{projectID} or projects/{projectNumber}, where {projectID} and {projectNumber} can be found in the Google Cloud console (https://support.google.com/cloud/answer/6158840).Examples: projects/my-project-123, projects/5551234. "A String", @@ -16238,10 +16158,6 @@

Method Details

"collapsibleGroup": { # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. "collapsed": True or False, # The collapsed state of the widget on first page load. }, - "coordinatedWidget": { # A widget that contains two widget visualizations that are coordinated in display. Currently, we only support the primary widget of TimeSeriesTable with the secondary widget of XyChart. # A widget that contains two widget visualizations that are coordinated in display. - "primary": # Object with schema name: Widget # Required. The primary visualization. Must be set. Must contain a data source. - "secondary": # Object with schema name: Widget # Required. The secondary visualization. Must be set. Must contain a data source. - }, "errorReportingPanel": { # A widget that displays a list of error groups. # A widget that displays a list of error groups. "projectNames": [ # The resource name of the Google Cloud Platform project. Written as projects/{projectID} or projects/{projectNumber}, where {projectID} and {projectNumber} can be found in the Google Cloud console (https://support.google.com/cloud/answer/6158840).Examples: projects/my-project-123, projects/5551234. "A String", @@ -17111,10 +17027,6 @@

Method Details

"collapsibleGroup": { # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. "collapsed": True or False, # The collapsed state of the widget on first page load. }, - "coordinatedWidget": { # A widget that contains two widget visualizations that are coordinated in display. Currently, we only support the primary widget of TimeSeriesTable with the secondary widget of XyChart. # A widget that contains two widget visualizations that are coordinated in display. - "primary": # Object with schema name: Widget # Required. The primary visualization. Must be set. Must contain a data source. - "secondary": # Object with schema name: Widget # Required. The secondary visualization. Must be set. Must contain a data source. - }, "errorReportingPanel": { # A widget that displays a list of error groups. # A widget that displays a list of error groups. "projectNames": [ # The resource name of the Google Cloud Platform project. Written as projects/{projectID} or projects/{projectNumber}, where {projectID} and {projectNumber} can be found in the Google Cloud console (https://support.google.com/cloud/answer/6158840).Examples: projects/my-project-123, projects/5551234. "A String", @@ -17880,10 +17792,6 @@

Method Details

"collapsibleGroup": { # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. "collapsed": True or False, # The collapsed state of the widget on first page load. }, - "coordinatedWidget": { # A widget that contains two widget visualizations that are coordinated in display. Currently, we only support the primary widget of TimeSeriesTable with the secondary widget of XyChart. # A widget that contains two widget visualizations that are coordinated in display. - "primary": # Object with schema name: Widget # Required. The primary visualization. Must be set. Must contain a data source. - "secondary": # Object with schema name: Widget # Required. The secondary visualization. Must be set. Must contain a data source. - }, "errorReportingPanel": { # A widget that displays a list of error groups. # A widget that displays a list of error groups. "projectNames": [ # The resource name of the Google Cloud Platform project. Written as projects/{projectID} or projects/{projectNumber}, where {projectID} and {projectNumber} can be found in the Google Cloud console (https://support.google.com/cloud/answer/6158840).Examples: projects/my-project-123, projects/5551234. "A String", @@ -18651,10 +18559,6 @@

Method Details

"collapsibleGroup": { # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. # A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. "collapsed": True or False, # The collapsed state of the widget on first page load. }, - "coordinatedWidget": { # A widget that contains two widget visualizations that are coordinated in display. Currently, we only support the primary widget of TimeSeriesTable with the secondary widget of XyChart. # A widget that contains two widget visualizations that are coordinated in display. - "primary": # Object with schema name: Widget # Required. The primary visualization. Must be set. Must contain a data source. - "secondary": # Object with schema name: Widget # Required. The secondary visualization. Must be set. Must contain a data source. - }, "errorReportingPanel": { # A widget that displays a list of error groups. # A widget that displays a list of error groups. "projectNames": [ # The resource name of the Google Cloud Platform project. Written as projects/{projectID} or projects/{projectNumber}, where {projectID} and {projectNumber} can be found in the Google Cloud console (https://support.google.com/cloud/answer/6158840).Examples: projects/my-project-123, projects/5551234. "A String", diff --git a/googleapiclient/discovery_cache/documents/monitoring.v1.json b/googleapiclient/discovery_cache/documents/monitoring.v1.json index 3ee8a6a740..866b4ad8e8 100644 --- a/googleapiclient/discovery_cache/documents/monitoring.v1.json +++ b/googleapiclient/discovery_cache/documents/monitoring.v1.json @@ -753,7 +753,7 @@ } } }, -"revision": "20260212", +"revision": "20260302", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { @@ -1087,21 +1087,6 @@ }, "type": "object" }, -"CoordinatedWidget": { -"description": "A widget that contains two widget visualizations that are coordinated in display. Currently, we only support the primary widget of TimeSeriesTable with the secondary widget of XyChart.", -"id": "CoordinatedWidget", -"properties": { -"primary": { -"$ref": "Widget", -"description": "Required. The primary visualization. Must be set. Must contain a data source." -}, -"secondary": { -"$ref": "Widget", -"description": "Required. The secondary visualization. Must be set. Must contain a data source." -} -}, -"type": "object" -}, "Dashboard": { "description": "A Google Stackdriver dashboard. Dashboards define the content and layout of pages in the Stackdriver web application.", "id": "Dashboard", @@ -3021,10 +3006,6 @@ "$ref": "CollapsibleGroup", "description": "A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets." }, -"coordinatedWidget": { -"$ref": "CoordinatedWidget", -"description": "A widget that contains two widget visualizations that are coordinated in display." -}, "errorReportingPanel": { "$ref": "ErrorReportingPanel", "description": "A widget that displays a list of error groups." From 701b49119b61553bbd62b56f026f6dcd245b2e3d Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 10 Mar 2026 07:24:06 +0000 Subject: [PATCH 21/31] feat(networkmanagement): update the api #### networkmanagement:v1 The following keys were added: - schemas.GkeNetworkPolicyInfo (Total Keys: 6) - schemas.GkeNetworkPolicySkippedInfo (Total Keys: 3) - schemas.Step.properties.gkeNetworkPolicy (Total Keys: 2) #### networkmanagement:v1beta1 The following keys were added: - schemas.GkeNetworkPolicyInfo (Total Keys: 6) - schemas.GkeNetworkPolicySkippedInfo (Total Keys: 3) - schemas.Step.properties.gkeNetworkPolicy (Total Keys: 2) --- ...s.locations.global_.connectivityTests.html | 72 +++++++++++++++++ ...s.locations.global_.connectivityTests.html | 72 +++++++++++++++++ .../documents/networkmanagement.v1.json | 77 ++++++++++++++++++- .../documents/networkmanagement.v1beta1.json | 77 ++++++++++++++++++- 4 files changed, 296 insertions(+), 2 deletions(-) diff --git a/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html b/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html index 91dad4bf3d..eef3c069d5 100644 --- a/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html +++ b/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html @@ -357,6 +357,15 @@

Method Details

"externalIp": "A String", # External IP address of a GKE cluster control plane. "internalIp": "A String", # Internal IP address of a GKE cluster control plane. }, + "gkeNetworkPolicy": { # For display only. Metadata associated with a GKE Network Policy. # Display information of a GKE Network Policy. + "action": "A String", # Possible values: ALLOW, DENY + "direction": "A String", # Possible values: INGRESS, EGRESS + "displayName": "A String", # The name of the Network Policy. + "uri": "A String", # The URI of the Network Policy. Format for a Network Policy in a zonal cluster: `projects//zones//clusters//k8s/namespaces//networking.k8s.io/networkpolicies/` Format for a Network Policy in a regional cluster: `projects//locations//clusters//k8s/namespaces//networking.k8s.io/networkpolicies/` + }, + "gkeNetworkPolicySkipped": { # For display only. Contains information about why GKE Network Policy evaluation was skipped. # Display information of the reason why GKE Network Policy evaluation was skipped. + "reason": "A String", # Reason why Network Policy evaluation was skipped. + }, "gkePod": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) Pod. # Display information of a Google Kubernetes Engine Pod. "ipAddress": "A String", # IP address of a GKE Pod. If the Pod is dual-stack, this is the IP address relevant to the trace. "networkUri": "A String", # URI of the network containing the GKE Pod. @@ -703,6 +712,15 @@

Method Details

"externalIp": "A String", # External IP address of a GKE cluster control plane. "internalIp": "A String", # Internal IP address of a GKE cluster control plane. }, + "gkeNetworkPolicy": { # For display only. Metadata associated with a GKE Network Policy. # Display information of a GKE Network Policy. + "action": "A String", # Possible values: ALLOW, DENY + "direction": "A String", # Possible values: INGRESS, EGRESS + "displayName": "A String", # The name of the Network Policy. + "uri": "A String", # The URI of the Network Policy. Format for a Network Policy in a zonal cluster: `projects//zones//clusters//k8s/namespaces//networking.k8s.io/networkpolicies/` Format for a Network Policy in a regional cluster: `projects//locations//clusters//k8s/namespaces//networking.k8s.io/networkpolicies/` + }, + "gkeNetworkPolicySkipped": { # For display only. Contains information about why GKE Network Policy evaluation was skipped. # Display information of the reason why GKE Network Policy evaluation was skipped. + "reason": "A String", # Reason why Network Policy evaluation was skipped. + }, "gkePod": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) Pod. # Display information of a Google Kubernetes Engine Pod. "ipAddress": "A String", # IP address of a GKE Pod. If the Pod is dual-stack, this is the IP address relevant to the trace. "networkUri": "A String", # URI of the network containing the GKE Pod. @@ -1252,6 +1270,15 @@

Method Details

"externalIp": "A String", # External IP address of a GKE cluster control plane. "internalIp": "A String", # Internal IP address of a GKE cluster control plane. }, + "gkeNetworkPolicy": { # For display only. Metadata associated with a GKE Network Policy. # Display information of a GKE Network Policy. + "action": "A String", # Possible values: ALLOW, DENY + "direction": "A String", # Possible values: INGRESS, EGRESS + "displayName": "A String", # The name of the Network Policy. + "uri": "A String", # The URI of the Network Policy. Format for a Network Policy in a zonal cluster: `projects//zones//clusters//k8s/namespaces//networking.k8s.io/networkpolicies/` Format for a Network Policy in a regional cluster: `projects//locations//clusters//k8s/namespaces//networking.k8s.io/networkpolicies/` + }, + "gkeNetworkPolicySkipped": { # For display only. Contains information about why GKE Network Policy evaluation was skipped. # Display information of the reason why GKE Network Policy evaluation was skipped. + "reason": "A String", # Reason why Network Policy evaluation was skipped. + }, "gkePod": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) Pod. # Display information of a Google Kubernetes Engine Pod. "ipAddress": "A String", # IP address of a GKE Pod. If the Pod is dual-stack, this is the IP address relevant to the trace. "networkUri": "A String", # URI of the network containing the GKE Pod. @@ -1598,6 +1625,15 @@

Method Details

"externalIp": "A String", # External IP address of a GKE cluster control plane. "internalIp": "A String", # Internal IP address of a GKE cluster control plane. }, + "gkeNetworkPolicy": { # For display only. Metadata associated with a GKE Network Policy. # Display information of a GKE Network Policy. + "action": "A String", # Possible values: ALLOW, DENY + "direction": "A String", # Possible values: INGRESS, EGRESS + "displayName": "A String", # The name of the Network Policy. + "uri": "A String", # The URI of the Network Policy. Format for a Network Policy in a zonal cluster: `projects//zones//clusters//k8s/namespaces//networking.k8s.io/networkpolicies/` Format for a Network Policy in a regional cluster: `projects//locations//clusters//k8s/namespaces//networking.k8s.io/networkpolicies/` + }, + "gkeNetworkPolicySkipped": { # For display only. Contains information about why GKE Network Policy evaluation was skipped. # Display information of the reason why GKE Network Policy evaluation was skipped. + "reason": "A String", # Reason why Network Policy evaluation was skipped. + }, "gkePod": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) Pod. # Display information of a Google Kubernetes Engine Pod. "ipAddress": "A String", # IP address of a GKE Pod. If the Pod is dual-stack, this is the IP address relevant to the trace. "networkUri": "A String", # URI of the network containing the GKE Pod. @@ -2138,6 +2174,15 @@

Method Details

"externalIp": "A String", # External IP address of a GKE cluster control plane. "internalIp": "A String", # Internal IP address of a GKE cluster control plane. }, + "gkeNetworkPolicy": { # For display only. Metadata associated with a GKE Network Policy. # Display information of a GKE Network Policy. + "action": "A String", # Possible values: ALLOW, DENY + "direction": "A String", # Possible values: INGRESS, EGRESS + "displayName": "A String", # The name of the Network Policy. + "uri": "A String", # The URI of the Network Policy. Format for a Network Policy in a zonal cluster: `projects//zones//clusters//k8s/namespaces//networking.k8s.io/networkpolicies/` Format for a Network Policy in a regional cluster: `projects//locations//clusters//k8s/namespaces//networking.k8s.io/networkpolicies/` + }, + "gkeNetworkPolicySkipped": { # For display only. Contains information about why GKE Network Policy evaluation was skipped. # Display information of the reason why GKE Network Policy evaluation was skipped. + "reason": "A String", # Reason why Network Policy evaluation was skipped. + }, "gkePod": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) Pod. # Display information of a Google Kubernetes Engine Pod. "ipAddress": "A String", # IP address of a GKE Pod. If the Pod is dual-stack, this is the IP address relevant to the trace. "networkUri": "A String", # URI of the network containing the GKE Pod. @@ -2484,6 +2529,15 @@

Method Details

"externalIp": "A String", # External IP address of a GKE cluster control plane. "internalIp": "A String", # Internal IP address of a GKE cluster control plane. }, + "gkeNetworkPolicy": { # For display only. Metadata associated with a GKE Network Policy. # Display information of a GKE Network Policy. + "action": "A String", # Possible values: ALLOW, DENY + "direction": "A String", # Possible values: INGRESS, EGRESS + "displayName": "A String", # The name of the Network Policy. + "uri": "A String", # The URI of the Network Policy. Format for a Network Policy in a zonal cluster: `projects//zones//clusters//k8s/namespaces//networking.k8s.io/networkpolicies/` Format for a Network Policy in a regional cluster: `projects//locations//clusters//k8s/namespaces//networking.k8s.io/networkpolicies/` + }, + "gkeNetworkPolicySkipped": { # For display only. Contains information about why GKE Network Policy evaluation was skipped. # Display information of the reason why GKE Network Policy evaluation was skipped. + "reason": "A String", # Reason why Network Policy evaluation was skipped. + }, "gkePod": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) Pod. # Display information of a Google Kubernetes Engine Pod. "ipAddress": "A String", # IP address of a GKE Pod. If the Pod is dual-stack, this is the IP address relevant to the trace. "networkUri": "A String", # URI of the network containing the GKE Pod. @@ -2983,6 +3037,15 @@

Method Details

"externalIp": "A String", # External IP address of a GKE cluster control plane. "internalIp": "A String", # Internal IP address of a GKE cluster control plane. }, + "gkeNetworkPolicy": { # For display only. Metadata associated with a GKE Network Policy. # Display information of a GKE Network Policy. + "action": "A String", # Possible values: ALLOW, DENY + "direction": "A String", # Possible values: INGRESS, EGRESS + "displayName": "A String", # The name of the Network Policy. + "uri": "A String", # The URI of the Network Policy. Format for a Network Policy in a zonal cluster: `projects//zones//clusters//k8s/namespaces//networking.k8s.io/networkpolicies/` Format for a Network Policy in a regional cluster: `projects//locations//clusters//k8s/namespaces//networking.k8s.io/networkpolicies/` + }, + "gkeNetworkPolicySkipped": { # For display only. Contains information about why GKE Network Policy evaluation was skipped. # Display information of the reason why GKE Network Policy evaluation was skipped. + "reason": "A String", # Reason why Network Policy evaluation was skipped. + }, "gkePod": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) Pod. # Display information of a Google Kubernetes Engine Pod. "ipAddress": "A String", # IP address of a GKE Pod. If the Pod is dual-stack, this is the IP address relevant to the trace. "networkUri": "A String", # URI of the network containing the GKE Pod. @@ -3329,6 +3392,15 @@

Method Details

"externalIp": "A String", # External IP address of a GKE cluster control plane. "internalIp": "A String", # Internal IP address of a GKE cluster control plane. }, + "gkeNetworkPolicy": { # For display only. Metadata associated with a GKE Network Policy. # Display information of a GKE Network Policy. + "action": "A String", # Possible values: ALLOW, DENY + "direction": "A String", # Possible values: INGRESS, EGRESS + "displayName": "A String", # The name of the Network Policy. + "uri": "A String", # The URI of the Network Policy. Format for a Network Policy in a zonal cluster: `projects//zones//clusters//k8s/namespaces//networking.k8s.io/networkpolicies/` Format for a Network Policy in a regional cluster: `projects//locations//clusters//k8s/namespaces//networking.k8s.io/networkpolicies/` + }, + "gkeNetworkPolicySkipped": { # For display only. Contains information about why GKE Network Policy evaluation was skipped. # Display information of the reason why GKE Network Policy evaluation was skipped. + "reason": "A String", # Reason why Network Policy evaluation was skipped. + }, "gkePod": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) Pod. # Display information of a Google Kubernetes Engine Pod. "ipAddress": "A String", # IP address of a GKE Pod. If the Pod is dual-stack, this is the IP address relevant to the trace. "networkUri": "A String", # URI of the network containing the GKE Pod. diff --git a/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html b/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html index d6aa3563e6..56b1bcdd3d 100644 --- a/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html +++ b/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html @@ -357,6 +357,15 @@

Method Details

"externalIp": "A String", # External IP address of a GKE cluster control plane. "internalIp": "A String", # Internal IP address of a GKE cluster control plane. }, + "gkeNetworkPolicy": { # For display only. Metadata associated with a GKE Network Policy. # Display information of a GKE Network Policy. + "action": "A String", # Possible values: ALLOW, DENY + "direction": "A String", # Possible values: INGRESS, EGRESS + "displayName": "A String", # The name of the Network Policy. + "uri": "A String", # The URI of the Network Policy. Format for a Network Policy in a zonal cluster: `projects//zones//clusters//k8s/namespaces//networking.k8s.io/networkpolicies/` Format for a Network Policy in a regional cluster: `projects//locations//clusters//k8s/namespaces//networking.k8s.io/networkpolicies/` + }, + "gkeNetworkPolicySkipped": { # For display only. Contains information about why GKE Network Policy evaluation was skipped. # Display information of the reason why GKE Network Policy evaluation was skipped. + "reason": "A String", # Reason why Network Policy evaluation was skipped. + }, "gkePod": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) Pod. # Display information of a Google Kubernetes Engine Pod. "ipAddress": "A String", # IP address of a GKE Pod. If the Pod is dual-stack, this is the IP address relevant to the trace. "networkUri": "A String", # URI of the network containing the GKE Pod. @@ -703,6 +712,15 @@

Method Details

"externalIp": "A String", # External IP address of a GKE cluster control plane. "internalIp": "A String", # Internal IP address of a GKE cluster control plane. }, + "gkeNetworkPolicy": { # For display only. Metadata associated with a GKE Network Policy. # Display information of a GKE Network Policy. + "action": "A String", # Possible values: ALLOW, DENY + "direction": "A String", # Possible values: INGRESS, EGRESS + "displayName": "A String", # The name of the Network Policy. + "uri": "A String", # The URI of the Network Policy. Format for a Network Policy in a zonal cluster: `projects//zones//clusters//k8s/namespaces//networking.k8s.io/networkpolicies/` Format for a Network Policy in a regional cluster: `projects//locations//clusters//k8s/namespaces//networking.k8s.io/networkpolicies/` + }, + "gkeNetworkPolicySkipped": { # For display only. Contains information about why GKE Network Policy evaluation was skipped. # Display information of the reason why GKE Network Policy evaluation was skipped. + "reason": "A String", # Reason why Network Policy evaluation was skipped. + }, "gkePod": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) Pod. # Display information of a Google Kubernetes Engine Pod. "ipAddress": "A String", # IP address of a GKE Pod. If the Pod is dual-stack, this is the IP address relevant to the trace. "networkUri": "A String", # URI of the network containing the GKE Pod. @@ -1252,6 +1270,15 @@

Method Details

"externalIp": "A String", # External IP address of a GKE cluster control plane. "internalIp": "A String", # Internal IP address of a GKE cluster control plane. }, + "gkeNetworkPolicy": { # For display only. Metadata associated with a GKE Network Policy. # Display information of a GKE Network Policy. + "action": "A String", # Possible values: ALLOW, DENY + "direction": "A String", # Possible values: INGRESS, EGRESS + "displayName": "A String", # The name of the Network Policy. + "uri": "A String", # The URI of the Network Policy. Format for a Network Policy in a zonal cluster: `projects//zones//clusters//k8s/namespaces//networking.k8s.io/networkpolicies/` Format for a Network Policy in a regional cluster: `projects//locations//clusters//k8s/namespaces//networking.k8s.io/networkpolicies/` + }, + "gkeNetworkPolicySkipped": { # For display only. Contains information about why GKE Network Policy evaluation was skipped. # Display information of the reason why GKE Network Policy evaluation was skipped. + "reason": "A String", # Reason why Network Policy evaluation was skipped. + }, "gkePod": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) Pod. # Display information of a Google Kubernetes Engine Pod. "ipAddress": "A String", # IP address of a GKE Pod. If the Pod is dual-stack, this is the IP address relevant to the trace. "networkUri": "A String", # URI of the network containing the GKE Pod. @@ -1598,6 +1625,15 @@

Method Details

"externalIp": "A String", # External IP address of a GKE cluster control plane. "internalIp": "A String", # Internal IP address of a GKE cluster control plane. }, + "gkeNetworkPolicy": { # For display only. Metadata associated with a GKE Network Policy. # Display information of a GKE Network Policy. + "action": "A String", # Possible values: ALLOW, DENY + "direction": "A String", # Possible values: INGRESS, EGRESS + "displayName": "A String", # The name of the Network Policy. + "uri": "A String", # The URI of the Network Policy. Format for a Network Policy in a zonal cluster: `projects//zones//clusters//k8s/namespaces//networking.k8s.io/networkpolicies/` Format for a Network Policy in a regional cluster: `projects//locations//clusters//k8s/namespaces//networking.k8s.io/networkpolicies/` + }, + "gkeNetworkPolicySkipped": { # For display only. Contains information about why GKE Network Policy evaluation was skipped. # Display information of the reason why GKE Network Policy evaluation was skipped. + "reason": "A String", # Reason why Network Policy evaluation was skipped. + }, "gkePod": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) Pod. # Display information of a Google Kubernetes Engine Pod. "ipAddress": "A String", # IP address of a GKE Pod. If the Pod is dual-stack, this is the IP address relevant to the trace. "networkUri": "A String", # URI of the network containing the GKE Pod. @@ -2138,6 +2174,15 @@

Method Details

"externalIp": "A String", # External IP address of a GKE cluster control plane. "internalIp": "A String", # Internal IP address of a GKE cluster control plane. }, + "gkeNetworkPolicy": { # For display only. Metadata associated with a GKE Network Policy. # Display information of a GKE Network Policy. + "action": "A String", # Possible values: ALLOW, DENY + "direction": "A String", # Possible values: INGRESS, EGRESS + "displayName": "A String", # The name of the Network Policy. + "uri": "A String", # The URI of the Network Policy. Format for a Network Policy in a zonal cluster: `projects//zones//clusters//k8s/namespaces//networking.k8s.io/networkpolicies/` Format for a Network Policy in a regional cluster: `projects//locations//clusters//k8s/namespaces//networking.k8s.io/networkpolicies/` + }, + "gkeNetworkPolicySkipped": { # For display only. Contains information about why GKE Network Policy evaluation was skipped. # Display information of the reason why GKE Network Policy evaluation was skipped. + "reason": "A String", # Reason why Network Policy evaluation was skipped. + }, "gkePod": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) Pod. # Display information of a Google Kubernetes Engine Pod. "ipAddress": "A String", # IP address of a GKE Pod. If the Pod is dual-stack, this is the IP address relevant to the trace. "networkUri": "A String", # URI of the network containing the GKE Pod. @@ -2484,6 +2529,15 @@

Method Details

"externalIp": "A String", # External IP address of a GKE cluster control plane. "internalIp": "A String", # Internal IP address of a GKE cluster control plane. }, + "gkeNetworkPolicy": { # For display only. Metadata associated with a GKE Network Policy. # Display information of a GKE Network Policy. + "action": "A String", # Possible values: ALLOW, DENY + "direction": "A String", # Possible values: INGRESS, EGRESS + "displayName": "A String", # The name of the Network Policy. + "uri": "A String", # The URI of the Network Policy. Format for a Network Policy in a zonal cluster: `projects//zones//clusters//k8s/namespaces//networking.k8s.io/networkpolicies/` Format for a Network Policy in a regional cluster: `projects//locations//clusters//k8s/namespaces//networking.k8s.io/networkpolicies/` + }, + "gkeNetworkPolicySkipped": { # For display only. Contains information about why GKE Network Policy evaluation was skipped. # Display information of the reason why GKE Network Policy evaluation was skipped. + "reason": "A String", # Reason why Network Policy evaluation was skipped. + }, "gkePod": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) Pod. # Display information of a Google Kubernetes Engine Pod. "ipAddress": "A String", # IP address of a GKE Pod. If the Pod is dual-stack, this is the IP address relevant to the trace. "networkUri": "A String", # URI of the network containing the GKE Pod. @@ -2983,6 +3037,15 @@

Method Details

"externalIp": "A String", # External IP address of a GKE cluster control plane. "internalIp": "A String", # Internal IP address of a GKE cluster control plane. }, + "gkeNetworkPolicy": { # For display only. Metadata associated with a GKE Network Policy. # Display information of a GKE Network Policy. + "action": "A String", # Possible values: ALLOW, DENY + "direction": "A String", # Possible values: INGRESS, EGRESS + "displayName": "A String", # The name of the Network Policy. + "uri": "A String", # The URI of the Network Policy. Format for a Network Policy in a zonal cluster: `projects//zones//clusters//k8s/namespaces//networking.k8s.io/networkpolicies/` Format for a Network Policy in a regional cluster: `projects//locations//clusters//k8s/namespaces//networking.k8s.io/networkpolicies/` + }, + "gkeNetworkPolicySkipped": { # For display only. Contains information about why GKE Network Policy evaluation was skipped. # Display information of the reason why GKE Network Policy evaluation was skipped. + "reason": "A String", # Reason why Network Policy evaluation was skipped. + }, "gkePod": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) Pod. # Display information of a Google Kubernetes Engine Pod. "ipAddress": "A String", # IP address of a GKE Pod. If the Pod is dual-stack, this is the IP address relevant to the trace. "networkUri": "A String", # URI of the network containing the GKE Pod. @@ -3329,6 +3392,15 @@

Method Details

"externalIp": "A String", # External IP address of a GKE cluster control plane. "internalIp": "A String", # Internal IP address of a GKE cluster control plane. }, + "gkeNetworkPolicy": { # For display only. Metadata associated with a GKE Network Policy. # Display information of a GKE Network Policy. + "action": "A String", # Possible values: ALLOW, DENY + "direction": "A String", # Possible values: INGRESS, EGRESS + "displayName": "A String", # The name of the Network Policy. + "uri": "A String", # The URI of the Network Policy. Format for a Network Policy in a zonal cluster: `projects//zones//clusters//k8s/namespaces//networking.k8s.io/networkpolicies/` Format for a Network Policy in a regional cluster: `projects//locations//clusters//k8s/namespaces//networking.k8s.io/networkpolicies/` + }, + "gkeNetworkPolicySkipped": { # For display only. Contains information about why GKE Network Policy evaluation was skipped. # Display information of the reason why GKE Network Policy evaluation was skipped. + "reason": "A String", # Reason why Network Policy evaluation was skipped. + }, "gkePod": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) Pod. # Display information of a Google Kubernetes Engine Pod. "ipAddress": "A String", # IP address of a GKE Pod. If the Pod is dual-stack, this is the IP address relevant to the trace. "networkUri": "A String", # URI of the network containing the GKE Pod. diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json index fb2ef5b008..c735da2e32 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json @@ -1237,7 +1237,7 @@ } } }, -"revision": "20260211", +"revision": "20260225", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -1926,6 +1926,7 @@ false "NCC_ROUTE_WITHIN_HYBRID_SUBNET_UNSUPPORTED", "HYBRID_SUBNET_REGION_MISMATCH", "HYBRID_SUBNET_NO_ROUTE", +"GKE_NETWORK_POLICY", "NO_VALID_ROUTE_FROM_GOOGLE_MANAGED_NETWORK_TO_DESTINATION" ], "enumDescriptions": [ @@ -2032,6 +2033,7 @@ false "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.", "Packet is dropped because no matching route was found in the hybrid subnet.", +"Packet is dropped by GKE Network Policy.", "Packet is dropped because there is no valid matching route from the network of the Google-managed service to the destination." ], "type": "string" @@ -2655,6 +2657,56 @@ false }, "type": "object" }, +"GkeNetworkPolicyInfo": { +"description": "For display only. Metadata associated with a GKE Network Policy.", +"id": "GkeNetworkPolicyInfo", +"properties": { +"action": { +"description": "Possible values: ALLOW, DENY", +"type": "string" +}, +"direction": { +"description": "Possible values: INGRESS, EGRESS", +"type": "string" +}, +"displayName": { +"description": "The name of the Network Policy.", +"type": "string" +}, +"uri": { +"description": "The URI of the Network Policy. Format for a Network Policy in a zonal cluster: `projects//zones//clusters//k8s/namespaces//networking.k8s.io/networkpolicies/` Format for a Network Policy in a regional cluster: `projects//locations//clusters//k8s/namespaces//networking.k8s.io/networkpolicies/`", +"type": "string" +} +}, +"type": "object" +}, +"GkeNetworkPolicySkippedInfo": { +"description": "For display only. Contains information about why GKE Network Policy evaluation was skipped.", +"id": "GkeNetworkPolicySkippedInfo", +"properties": { +"reason": { +"description": "Reason why Network Policy evaluation was skipped.", +"enum": [ +"REASON_UNSPECIFIED", +"NETWORK_POLICY_DISABLED", +"INGRESS_SOURCE_ON_SAME_NODE", +"EGRESS_FROM_NODE_NETWORK_NAMESPACE_POD", +"NETWORK_POLICY_NOT_APPLIED_TO_RESPONSE_TRAFFIC", +"NETWORK_POLICY_ANALYSIS_UNSUPPORTED" +], +"enumDescriptions": [ +"Unused default value.", +"Network Policy is disabled on the cluster.", +"Ingress traffic to a Pod from a source on the same Node is always allowed.", +"Egress traffic from a Pod that uses the Node's network namespace is not subject to Network Policy.", +"Network Policy is not applied to response traffic. This is because GKE Network Policy evaluation is stateful in both GKE Dataplane V2 (eBPF) and legacy (iptables) implementations.", +"Network Policy evaluation is currently not supported for clusters with FQDN Network Policies enabled." +], +"type": "string" +} +}, +"type": "object" +}, "GkePodInfo": { "description": "For display only. Metadata associated with a Google Kubernetes Engine (GKE) Pod.", "id": "GkePodInfo", @@ -4094,6 +4146,14 @@ false "$ref": "GKEMasterInfo", "description": "Display information of a Google Kubernetes Engine cluster master." }, +"gkeNetworkPolicy": { +"$ref": "GkeNetworkPolicyInfo", +"description": "Display information of a GKE Network Policy." +}, +"gkeNetworkPolicySkipped": { +"$ref": "GkeNetworkPolicySkippedInfo", +"description": "Display information of the reason why GKE Network Policy evaluation was skipped." +}, "gkePod": { "$ref": "GkePodInfo", "description": "Display information of a Google Kubernetes Engine Pod." @@ -4200,11 +4260,16 @@ false "ARRIVE_AT_VPN_TUNNEL", "ARRIVE_AT_INTERCONNECT_ATTACHMENT", "ARRIVE_AT_VPC_CONNECTOR", +"ARRIVE_AT_GKE_POD", "DIRECT_VPC_EGRESS_CONNECTION", "SERVERLESS_EXTERNAL_CONNECTION", "NGFW_PACKET_INSPECTION", "NAT", "SKIP_GKE_POD_IP_MASQUERADING", +"SKIP_GKE_INGRESS_NETWORK_POLICY", +"SKIP_GKE_EGRESS_NETWORK_POLICY", +"APPLY_INGRESS_GKE_NETWORK_POLICY", +"APPLY_EGRESS_GKE_NETWORK_POLICY", "PROXY_CONNECTION", "DELIVER", "DROP", @@ -4253,6 +4318,11 @@ false, false, false, false, +false, +false, +false, +false, +false, false ], "enumDescriptions": [ @@ -4286,11 +4356,16 @@ false "Forwarding state: arriving at a Cloud VPN tunnel.", "Forwarding state: arriving at an interconnect attachment.", "Forwarding state: arriving at a VPC connector.", +"Forwarding state: arriving at a GKE Pod.", "Forwarding state: for packets originating from a serverless endpoint forwarded through Direct VPC egress.", "Forwarding state: for packets originating from a serverless endpoint forwarded through public (external) connectivity.", "Forwarding state: Layer 7 packet inspection by the firewall endpoint based on the configured security profile group.", "Transition state: packet header translated. The `nat` field is populated with the translation information.", "Transition state: GKE Pod IP masquerading is skipped. The `ip_masquerading_skipped` field is populated with the reason.", +"Transition state: GKE Ingress Network Policy is skipped. The `gke_network_policy_skipped` field is populated with the reason.", +"Transition state: GKE Egress Network Policy is skipped. The `gke_network_policy_skipped` field is populated with the reason.", +"Config checking state: verify ingress GKE network policy.", +"Config checking state: verify egress GKE network policy.", "Transition state: original connection is terminated and a new proxied connection is initiated.", "Final state: packet could be delivered.", "Final state: packet could be dropped.", diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json index 00678dc592..9939fdd859 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json @@ -1237,7 +1237,7 @@ } } }, -"revision": "20260211", +"revision": "20260225", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -1926,6 +1926,7 @@ false "NCC_ROUTE_WITHIN_HYBRID_SUBNET_UNSUPPORTED", "HYBRID_SUBNET_REGION_MISMATCH", "HYBRID_SUBNET_NO_ROUTE", +"GKE_NETWORK_POLICY", "NO_VALID_ROUTE_FROM_GOOGLE_MANAGED_NETWORK_TO_DESTINATION" ], "enumDescriptions": [ @@ -2032,6 +2033,7 @@ false "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.", "Packet is dropped because no matching route was found in the hybrid subnet.", +"Packet is dropped by GKE Network Policy.", "Packet is dropped because there is no valid matching route from the network of the Google-managed service to the destination." ], "type": "string" @@ -2655,6 +2657,56 @@ false }, "type": "object" }, +"GkeNetworkPolicyInfo": { +"description": "For display only. Metadata associated with a GKE Network Policy.", +"id": "GkeNetworkPolicyInfo", +"properties": { +"action": { +"description": "Possible values: ALLOW, DENY", +"type": "string" +}, +"direction": { +"description": "Possible values: INGRESS, EGRESS", +"type": "string" +}, +"displayName": { +"description": "The name of the Network Policy.", +"type": "string" +}, +"uri": { +"description": "The URI of the Network Policy. Format for a Network Policy in a zonal cluster: `projects//zones//clusters//k8s/namespaces//networking.k8s.io/networkpolicies/` Format for a Network Policy in a regional cluster: `projects//locations//clusters//k8s/namespaces//networking.k8s.io/networkpolicies/`", +"type": "string" +} +}, +"type": "object" +}, +"GkeNetworkPolicySkippedInfo": { +"description": "For display only. Contains information about why GKE Network Policy evaluation was skipped.", +"id": "GkeNetworkPolicySkippedInfo", +"properties": { +"reason": { +"description": "Reason why Network Policy evaluation was skipped.", +"enum": [ +"REASON_UNSPECIFIED", +"NETWORK_POLICY_DISABLED", +"INGRESS_SOURCE_ON_SAME_NODE", +"EGRESS_FROM_NODE_NETWORK_NAMESPACE_POD", +"NETWORK_POLICY_NOT_APPLIED_TO_RESPONSE_TRAFFIC", +"NETWORK_POLICY_ANALYSIS_UNSUPPORTED" +], +"enumDescriptions": [ +"Unused default value.", +"Network Policy is disabled on the cluster.", +"Ingress traffic to a Pod from a source on the same Node is always allowed.", +"Egress traffic from a Pod that uses the Node's network namespace is not subject to Network Policy.", +"Network Policy is not applied to response traffic. This is because GKE Network Policy evaluation is stateful in both GKE Dataplane V2 (eBPF) and legacy (iptables) implementations.", +"Network Policy evaluation is currently not supported for clusters with FQDN Network Policies enabled." +], +"type": "string" +} +}, +"type": "object" +}, "GkePodInfo": { "description": "For display only. Metadata associated with a Google Kubernetes Engine (GKE) Pod.", "id": "GkePodInfo", @@ -4094,6 +4146,14 @@ false "$ref": "GKEMasterInfo", "description": "Display information of a Google Kubernetes Engine cluster master." }, +"gkeNetworkPolicy": { +"$ref": "GkeNetworkPolicyInfo", +"description": "Display information of a GKE Network Policy." +}, +"gkeNetworkPolicySkipped": { +"$ref": "GkeNetworkPolicySkippedInfo", +"description": "Display information of the reason why GKE Network Policy evaluation was skipped." +}, "gkePod": { "$ref": "GkePodInfo", "description": "Display information of a Google Kubernetes Engine Pod." @@ -4200,11 +4260,16 @@ false "ARRIVE_AT_VPN_TUNNEL", "ARRIVE_AT_INTERCONNECT_ATTACHMENT", "ARRIVE_AT_VPC_CONNECTOR", +"ARRIVE_AT_GKE_POD", "DIRECT_VPC_EGRESS_CONNECTION", "SERVERLESS_EXTERNAL_CONNECTION", "NGFW_PACKET_INSPECTION", "NAT", "SKIP_GKE_POD_IP_MASQUERADING", +"SKIP_GKE_INGRESS_NETWORK_POLICY", +"SKIP_GKE_EGRESS_NETWORK_POLICY", +"APPLY_INGRESS_GKE_NETWORK_POLICY", +"APPLY_EGRESS_GKE_NETWORK_POLICY", "PROXY_CONNECTION", "DELIVER", "DROP", @@ -4253,6 +4318,11 @@ false, false, false, false, +false, +false, +false, +false, +false, false ], "enumDescriptions": [ @@ -4286,11 +4356,16 @@ false "Forwarding state: arriving at a Cloud VPN tunnel.", "Forwarding state: arriving at an interconnect attachment.", "Forwarding state: arriving at a VPC connector.", +"Forwarding state: arriving at a GKE Pod.", "Forwarding state: for packets originating from a serverless endpoint forwarded through Direct VPC egress.", "Forwarding state: for packets originating from a serverless endpoint forwarded through public (external) connectivity.", "Forwarding state: Layer 7 packet inspection by the firewall endpoint based on the configured security profile group.", "Transition state: packet header translated. The `nat` field is populated with the translation information.", "Transition state: GKE Pod IP masquerading is skipped. The `ip_masquerading_skipped` field is populated with the reason.", +"Transition state: GKE Ingress Network Policy is skipped. The `gke_network_policy_skipped` field is populated with the reason.", +"Transition state: GKE Egress Network Policy is skipped. The `gke_network_policy_skipped` field is populated with the reason.", +"Config checking state: verify ingress GKE network policy.", +"Config checking state: verify egress GKE network policy.", "Transition state: original connection is terminated and a new proxied connection is initiated.", "Final state: packet could be delivered.", "Final state: packet could be dropped.", From 3a45a9c38802f2100467f60a33ad222537b46167 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 10 Mar 2026 07:24:07 +0000 Subject: [PATCH 22/31] feat(networksecurity): update the api #### networksecurity:v1 The following keys were deleted: - resources.projects.resources.locations.resources.firewallEndpoints.methods.create (Total Keys: 16) - resources.projects.resources.locations.resources.firewallEndpoints.methods.delete (Total Keys: 13) - resources.projects.resources.locations.resources.firewallEndpoints.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.firewallEndpoints.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.firewallEndpoints.methods.patch (Total Keys: 17) #### networksecurity:v1beta1 The following keys were deleted: - resources.projects.resources.locations.resources.firewallEndpoints.methods.create (Total Keys: 16) - resources.projects.resources.locations.resources.firewallEndpoints.methods.delete (Total Keys: 13) - resources.projects.resources.locations.resources.firewallEndpoints.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.firewallEndpoints.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.firewallEndpoints.methods.patch (Total Keys: 17) --- ...networksecurity_v1.projects.locations.html | 5 - ...rksecurity_v1beta1.projects.locations.html | 5 - .../documents/networksecurity.v1.json | 184 +----------------- .../documents/networksecurity.v1beta1.json | 184 +----------------- 4 files changed, 2 insertions(+), 376 deletions(-) diff --git a/docs/dyn/networksecurity_v1.projects.locations.html b/docs/dyn/networksecurity_v1.projects.locations.html index 57ff34dd4d..6f3b2afa7b 100644 --- a/docs/dyn/networksecurity_v1.projects.locations.html +++ b/docs/dyn/networksecurity_v1.projects.locations.html @@ -109,11 +109,6 @@

Instance Methods

Returns the firewallEndpointAssociations Resource.

-

- firewallEndpoints() -

-

Returns the firewallEndpoints Resource.

-

gatewaySecurityPolicies()

diff --git a/docs/dyn/networksecurity_v1beta1.projects.locations.html b/docs/dyn/networksecurity_v1beta1.projects.locations.html index f68e508623..168a8c887b 100644 --- a/docs/dyn/networksecurity_v1beta1.projects.locations.html +++ b/docs/dyn/networksecurity_v1beta1.projects.locations.html @@ -109,11 +109,6 @@

Instance Methods

Returns the firewallEndpointAssociations Resource.

-

- firewallEndpoints() -

-

Returns the firewallEndpoints Resource.

-

gatewaySecurityPolicies()

diff --git a/googleapiclient/discovery_cache/documents/networksecurity.v1.json b/googleapiclient/discovery_cache/documents/networksecurity.v1.json index 8cba0b1ca8..1a683d26e9 100644 --- a/googleapiclient/discovery_cache/documents/networksecurity.v1.json +++ b/googleapiclient/discovery_cache/documents/networksecurity.v1.json @@ -2764,188 +2764,6 @@ } } }, -"firewallEndpoints": { -"methods": { -"create": { -"description": "Creates a new FirewallEndpoint in a given project and location.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/firewallEndpoints", -"httpMethod": "POST", -"id": "networksecurity.projects.locations.firewallEndpoints.create", -"parameterOrder": [ -"parent" -], -"parameters": { -"firewallEndpointId": { -"description": "Required. Id of the requesting object. If auto-generating Id server-side, remove this field and firewall_endpoint_id from the method_signature of Create RPC.", -"location": "query", -"type": "string" -}, -"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" -} -}, -"path": "v1/{+parent}/firewallEndpoints", -"request": { -"$ref": "FirewallEndpoint" -}, -"response": { -"$ref": "Operation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"delete": { -"description": "Deletes a single project Endpoint.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/firewallEndpoints/{firewallEndpointsId}", -"httpMethod": "DELETE", -"id": "networksecurity.projects.locations.firewallEndpoints.delete", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. Name of the resource", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/firewallEndpoints/[^/]+$", -"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": "Operation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"get": { -"description": "Gets details of a single project Endpoint.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/firewallEndpoints/{firewallEndpointsId}", -"httpMethod": "GET", -"id": "networksecurity.projects.locations.firewallEndpoints.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. Name of the resource", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/firewallEndpoints/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}", -"response": { -"$ref": "FirewallEndpoint" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"list": { -"description": "Lists FirewallEndpoints in a given project and location.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/firewallEndpoints", -"httpMethod": "GET", -"id": "networksecurity.projects.locations.firewallEndpoints.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"filter": { -"description": "Optional. Filtering results", -"location": "query", -"type": "string" -}, -"orderBy": { -"description": "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": "A token identifying a page of results the server should return.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. Parent value for ListEndpointsRequest", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+parent}/firewallEndpoints", -"response": { -"$ref": "ListFirewallEndpointsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"patch": { -"description": "Update a single project Endpoint.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/firewallEndpoints/{firewallEndpointsId}", -"httpMethod": "PATCH", -"id": "networksecurity.projects.locations.firewallEndpoints.patch", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Immutable. Identifier. Name of resource.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/firewallEndpoints/[^/]+$", -"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": "Required. Field mask is used to specify the fields to be overwritten in the Endpoint 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 will be overwritten.", -"format": "google-fieldmask", -"location": "query", -"type": "string" -} -}, -"path": "v1/{+name}", -"request": { -"$ref": "FirewallEndpoint" -}, -"response": { -"$ref": "Operation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -} -}, "gatewaySecurityPolicies": { "methods": { "create": { @@ -5419,7 +5237,7 @@ } } }, -"revision": "20260204", +"revision": "20260226", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AddAddressGroupItemsRequest": { diff --git a/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json b/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json index a2fb712ef1..3bcfffb516 100644 --- a/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json @@ -2764,188 +2764,6 @@ } } }, -"firewallEndpoints": { -"methods": { -"create": { -"description": "Creates a new FirewallEndpoint in a given project and location.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/firewallEndpoints", -"httpMethod": "POST", -"id": "networksecurity.projects.locations.firewallEndpoints.create", -"parameterOrder": [ -"parent" -], -"parameters": { -"firewallEndpointId": { -"description": "Required. Id of the requesting object. If auto-generating Id server-side, remove this field and firewall_endpoint_id from the method_signature of Create RPC.", -"location": "query", -"type": "string" -}, -"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" -} -}, -"path": "v1beta1/{+parent}/firewallEndpoints", -"request": { -"$ref": "FirewallEndpoint" -}, -"response": { -"$ref": "Operation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"delete": { -"description": "Deletes a single project Endpoint.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/firewallEndpoints/{firewallEndpointsId}", -"httpMethod": "DELETE", -"id": "networksecurity.projects.locations.firewallEndpoints.delete", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. Name of the resource", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/firewallEndpoints/[^/]+$", -"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": "v1beta1/{+name}", -"response": { -"$ref": "Operation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"get": { -"description": "Gets details of a single project Endpoint.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/firewallEndpoints/{firewallEndpointsId}", -"httpMethod": "GET", -"id": "networksecurity.projects.locations.firewallEndpoints.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. Name of the resource", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/firewallEndpoints/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+name}", -"response": { -"$ref": "FirewallEndpoint" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"list": { -"description": "Lists FirewallEndpoints in a given project and location.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/firewallEndpoints", -"httpMethod": "GET", -"id": "networksecurity.projects.locations.firewallEndpoints.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"filter": { -"description": "Optional. Filtering results", -"location": "query", -"type": "string" -}, -"orderBy": { -"description": "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": "A token identifying a page of results the server should return.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. Parent value for ListEndpointsRequest", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+parent}/firewallEndpoints", -"response": { -"$ref": "ListFirewallEndpointsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"patch": { -"description": "Update a single project Endpoint.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/firewallEndpoints/{firewallEndpointsId}", -"httpMethod": "PATCH", -"id": "networksecurity.projects.locations.firewallEndpoints.patch", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Immutable. Identifier. Name of resource.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/firewallEndpoints/[^/]+$", -"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": "Required. Field mask is used to specify the fields to be overwritten in the Endpoint 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 will be overwritten.", -"format": "google-fieldmask", -"location": "query", -"type": "string" -} -}, -"path": "v1beta1/{+name}", -"request": { -"$ref": "FirewallEndpoint" -}, -"response": { -"$ref": "Operation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -} -}, "gatewaySecurityPolicies": { "methods": { "create": { @@ -5705,7 +5523,7 @@ } } }, -"revision": "20260131", +"revision": "20260226", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AddAddressGroupItemsRequest": { From dbc8a725a632dfa9eae7aa17ee217ce6afc9fe6f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 10 Mar 2026 07:24:07 +0000 Subject: [PATCH 23/31] feat(networkservices): update the api #### networkservices:v1 The following keys were added: - schemas.AuthzExtension.properties.forwardAttributes (Total Keys: 2) - schemas.ExtensionChainExtension.properties.forwardAttributes (Total Keys: 2) #### networkservices:v1beta1 The following keys were added: - schemas.AuthzExtension.properties.forwardAttributes (Total Keys: 2) - schemas.ExtensionChainExtension.properties.forwardAttributes (Total Keys: 2) --- ...es_v1.projects.locations.authzExtensions.html | 12 ++++++++++++ ...s_v1.projects.locations.lbEdgeExtensions.html | 12 ++++++++++++ ..._v1.projects.locations.lbRouteExtensions.html | 12 ++++++++++++ ...1.projects.locations.lbTrafficExtensions.html | 12 ++++++++++++ ...beta1.projects.locations.authzExtensions.html | 12 ++++++++++++ ...eta1.projects.locations.lbEdgeExtensions.html | 12 ++++++++++++ ...ta1.projects.locations.lbRouteExtensions.html | 12 ++++++++++++ ...beta1.projects.locations.lbTcpExtensions.html | 12 ++++++++++++ ...1.projects.locations.lbTrafficExtensions.html | 12 ++++++++++++ .../documents/networkservices.v1.json | 16 +++++++++++++++- .../documents/networkservices.v1beta1.json | 16 +++++++++++++++- 11 files changed, 138 insertions(+), 2 deletions(-) diff --git a/docs/dyn/networkservices_v1.projects.locations.authzExtensions.html b/docs/dyn/networkservices_v1.projects.locations.authzExtensions.html index f812b86f96..0c96919962 100644 --- a/docs/dyn/networkservices_v1.projects.locations.authzExtensions.html +++ b/docs/dyn/networkservices_v1.projects.locations.authzExtensions.html @@ -115,6 +115,9 @@

Method Details

"createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A human-readable description of the resource. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. + "forwardAttributes": [ # Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name. + "A String", + ], "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], @@ -218,6 +221,9 @@

Method Details

"createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A human-readable description of the resource. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. + "forwardAttributes": [ # Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name. + "A String", + ], "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], @@ -261,6 +267,9 @@

Method Details

"createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A human-readable description of the resource. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. + "forwardAttributes": [ # Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name. + "A String", + ], "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], @@ -313,6 +322,9 @@

Method Details

"createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A human-readable description of the resource. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. + "forwardAttributes": [ # Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name. + "A String", + ], "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], diff --git a/docs/dyn/networkservices_v1.projects.locations.lbEdgeExtensions.html b/docs/dyn/networkservices_v1.projects.locations.lbEdgeExtensions.html index 8549aa0fbb..0c93df9946 100644 --- a/docs/dyn/networkservices_v1.projects.locations.lbEdgeExtensions.html +++ b/docs/dyn/networkservices_v1.projects.locations.lbEdgeExtensions.html @@ -119,6 +119,9 @@

Method Details

{ # A single extension in the chain to execute for the matching request. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. + "forwardAttributes": [ # Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name. + "A String", + ], "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], @@ -243,6 +246,9 @@

Method Details

{ # A single extension in the chain to execute for the matching request. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. + "forwardAttributes": [ # Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name. + "A String", + ], "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], @@ -307,6 +313,9 @@

Method Details

{ # A single extension in the chain to execute for the matching request. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. + "forwardAttributes": [ # Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name. + "A String", + ], "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], @@ -380,6 +389,9 @@

Method Details

{ # A single extension in the chain to execute for the matching request. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. + "forwardAttributes": [ # Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name. + "A String", + ], "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], diff --git a/docs/dyn/networkservices_v1.projects.locations.lbRouteExtensions.html b/docs/dyn/networkservices_v1.projects.locations.lbRouteExtensions.html index 733bb3c6ba..09cee11199 100644 --- a/docs/dyn/networkservices_v1.projects.locations.lbRouteExtensions.html +++ b/docs/dyn/networkservices_v1.projects.locations.lbRouteExtensions.html @@ -119,6 +119,9 @@

Method Details

{ # A single extension in the chain to execute for the matching request. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. + "forwardAttributes": [ # Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name. + "A String", + ], "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], @@ -246,6 +249,9 @@

Method Details

{ # A single extension in the chain to execute for the matching request. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. + "forwardAttributes": [ # Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name. + "A String", + ], "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], @@ -313,6 +319,9 @@

Method Details

{ # A single extension in the chain to execute for the matching request. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. + "forwardAttributes": [ # Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name. + "A String", + ], "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], @@ -389,6 +398,9 @@

Method Details

{ # A single extension in the chain to execute for the matching request. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. + "forwardAttributes": [ # Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name. + "A String", + ], "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], diff --git a/docs/dyn/networkservices_v1.projects.locations.lbTrafficExtensions.html b/docs/dyn/networkservices_v1.projects.locations.lbTrafficExtensions.html index 6a5197725c..b31c7aa35e 100644 --- a/docs/dyn/networkservices_v1.projects.locations.lbTrafficExtensions.html +++ b/docs/dyn/networkservices_v1.projects.locations.lbTrafficExtensions.html @@ -119,6 +119,9 @@

Method Details

{ # A single extension in the chain to execute for the matching request. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. + "forwardAttributes": [ # Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name. + "A String", + ], "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], @@ -246,6 +249,9 @@

Method Details

{ # A single extension in the chain to execute for the matching request. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. + "forwardAttributes": [ # Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name. + "A String", + ], "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], @@ -313,6 +319,9 @@

Method Details

{ # A single extension in the chain to execute for the matching request. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. + "forwardAttributes": [ # Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name. + "A String", + ], "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], @@ -389,6 +398,9 @@

Method Details

{ # A single extension in the chain to execute for the matching request. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. + "forwardAttributes": [ # Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name. + "A String", + ], "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.authzExtensions.html b/docs/dyn/networkservices_v1beta1.projects.locations.authzExtensions.html index 1324189954..e411b97673 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.authzExtensions.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.authzExtensions.html @@ -115,6 +115,9 @@

Method Details

"createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A human-readable description of the resource. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. + "forwardAttributes": [ # Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name. + "A String", + ], "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], @@ -218,6 +221,9 @@

Method Details

"createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A human-readable description of the resource. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. + "forwardAttributes": [ # Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name. + "A String", + ], "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], @@ -261,6 +267,9 @@

Method Details

"createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A human-readable description of the resource. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. + "forwardAttributes": [ # Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name. + "A String", + ], "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], @@ -313,6 +322,9 @@

Method Details

"createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A human-readable description of the resource. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. + "forwardAttributes": [ # Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name. + "A String", + ], "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.lbEdgeExtensions.html b/docs/dyn/networkservices_v1beta1.projects.locations.lbEdgeExtensions.html index 958f6b1cdf..248f9724b8 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.lbEdgeExtensions.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.lbEdgeExtensions.html @@ -120,6 +120,9 @@

Method Details

"allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. + "forwardAttributes": [ # Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name. + "A String", + ], "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], @@ -245,6 +248,9 @@

Method Details

"allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. + "forwardAttributes": [ # Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name. + "A String", + ], "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], @@ -310,6 +316,9 @@

Method Details

"allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. + "forwardAttributes": [ # Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name. + "A String", + ], "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], @@ -384,6 +393,9 @@

Method Details

"allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. + "forwardAttributes": [ # Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name. + "A String", + ], "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.lbRouteExtensions.html b/docs/dyn/networkservices_v1beta1.projects.locations.lbRouteExtensions.html index f9b7e1a06c..618b6a2f49 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.lbRouteExtensions.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.lbRouteExtensions.html @@ -120,6 +120,9 @@

Method Details

"allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. + "forwardAttributes": [ # Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name. + "A String", + ], "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], @@ -248,6 +251,9 @@

Method Details

"allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. + "forwardAttributes": [ # Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name. + "A String", + ], "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], @@ -316,6 +322,9 @@

Method Details

"allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. + "forwardAttributes": [ # Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name. + "A String", + ], "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], @@ -393,6 +402,9 @@

Method Details

"allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. + "forwardAttributes": [ # Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name. + "A String", + ], "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.lbTcpExtensions.html b/docs/dyn/networkservices_v1beta1.projects.locations.lbTcpExtensions.html index 672880d991..7f2cfeb9c0 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.lbTcpExtensions.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.lbTcpExtensions.html @@ -120,6 +120,9 @@

Method Details

"allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. + "forwardAttributes": [ # Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name. + "A String", + ], "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], @@ -245,6 +248,9 @@

Method Details

"allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. + "forwardAttributes": [ # Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name. + "A String", + ], "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], @@ -310,6 +316,9 @@

Method Details

"allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. + "forwardAttributes": [ # Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name. + "A String", + ], "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], @@ -384,6 +393,9 @@

Method Details

"allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. + "forwardAttributes": [ # Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name. + "A String", + ], "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.lbTrafficExtensions.html b/docs/dyn/networkservices_v1beta1.projects.locations.lbTrafficExtensions.html index 41038a1f63..8f50ed1fa9 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.lbTrafficExtensions.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.lbTrafficExtensions.html @@ -120,6 +120,9 @@

Method Details

"allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. + "forwardAttributes": [ # Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name. + "A String", + ], "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], @@ -248,6 +251,9 @@

Method Details

"allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. + "forwardAttributes": [ # Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name. + "A String", + ], "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], @@ -316,6 +322,9 @@

Method Details

"allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. + "forwardAttributes": [ # Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name. + "A String", + ], "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], @@ -393,6 +402,9 @@

Method Details

"allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. + "forwardAttributes": [ # Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name. + "A String", + ], "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], diff --git a/googleapiclient/discovery_cache/documents/networkservices.v1.json b/googleapiclient/discovery_cache/documents/networkservices.v1.json index b57614aadc..753634d7df 100644 --- a/googleapiclient/discovery_cache/documents/networkservices.v1.json +++ b/googleapiclient/discovery_cache/documents/networkservices.v1.json @@ -3191,7 +3191,7 @@ } } }, -"revision": "20260218", +"revision": "20260226", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuditConfig": { @@ -3264,6 +3264,13 @@ "description": "Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset.", "type": "boolean" }, +"forwardAttributes": { +"description": "Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name.", +"items": { +"type": "string" +}, +"type": "array" +}, "forwardHeaders": { "description": "Optional. List of the HTTP headers to forward to the extension (from the client). If omitted, all headers are sent. Each element is a string indicating the header name.", "items": { @@ -3549,6 +3556,13 @@ "description": "Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset.", "type": "boolean" }, +"forwardAttributes": { +"description": "Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name.", +"items": { +"type": "string" +}, +"type": "array" +}, "forwardHeaders": { "description": "Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name.", "items": { diff --git a/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json b/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json index d0ae98d915..dc9ab61b77 100644 --- a/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json @@ -3100,7 +3100,7 @@ } } }, -"revision": "20260218", +"revision": "20260226", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuthzExtension": { @@ -3125,6 +3125,13 @@ "description": "Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset.", "type": "boolean" }, +"forwardAttributes": { +"description": "Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name.", +"items": { +"type": "string" +}, +"type": "array" +}, "forwardHeaders": { "description": "Optional. List of the HTTP headers to forward to the extension (from the client). If omitted, all headers are sent. Each element is a string indicating the header name.", "items": { @@ -3330,6 +3337,13 @@ "description": "Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset.", "type": "boolean" }, +"forwardAttributes": { +"description": "Optional. List of the Envoy attributes to forward to the extension server. The attributes provided here are included as part of the `ProcessingRequest.attributes` field (of type `map`), where the keys are the attribute names. Refer to the [documentation](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference#attributes) for the names of attributes that can be forwarded. If omitted, no attributes are sent. Each element is a string indicating the attribute name.", +"items": { +"type": "string" +}, +"type": "array" +}, "forwardHeaders": { "description": "Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name.", "items": { From 7e66fdb3bd324f8ae0f2d6394a8f2f1c85c1c062 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 10 Mar 2026 07:24:07 +0000 Subject: [PATCH 24/31] feat(oracledatabase): update the api #### oracledatabase:v1 The following keys were added: - schemas.Database.properties.pluggableDatabaseId.type (Total Keys: 1) - schemas.Database.properties.pluggableDatabaseName.type (Total Keys: 1) --- ...oracledatabase_v1.projects.locations.databases.html | 4 ++++ ...oracledatabase_v1.projects.locations.dbSystems.html | 6 ++++++ .../discovery_cache/documents/oracledatabase.v1.json | 10 +++++++++- 3 files changed, 19 insertions(+), 1 deletion(-) diff --git a/docs/dyn/oracledatabase_v1.projects.locations.databases.html b/docs/dyn/oracledatabase_v1.projects.locations.databases.html index b60e36cd62..c4f0943dd5 100644 --- a/docs/dyn/oracledatabase_v1.projects.locations.databases.html +++ b/docs/dyn/oracledatabase_v1.projects.locations.databases.html @@ -119,6 +119,8 @@

Method Details

"ncharacterSet": "A String", # Optional. The national character set for the database. The default is AL16UTF16. "ociUrl": "A String", # Output only. HTTPS link to OCI resources exposed to Customer via UI Interface. "opsInsightsStatus": "A String", # Output only. The Status of Operations Insights for this Database. + "pluggableDatabaseId": "A String", # Optional. The ID of the pluggable database associated with the Database. The ID must be unique within the project and location. + "pluggableDatabaseName": "A String", # Optional. The pluggable database associated with the Database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. "properties": { # The properties of a Database. # Optional. The properties of the Database. "databaseManagementConfig": { # The configuration of the Database Management service. # Output only. The Database Management config. "managementState": "A String", # Output only. The status of the Database Management service. @@ -176,6 +178,8 @@

Method Details

"ncharacterSet": "A String", # Optional. The national character set for the database. The default is AL16UTF16. "ociUrl": "A String", # Output only. HTTPS link to OCI resources exposed to Customer via UI Interface. "opsInsightsStatus": "A String", # Output only. The Status of Operations Insights for this Database. + "pluggableDatabaseId": "A String", # Optional. The ID of the pluggable database associated with the Database. The ID must be unique within the project and location. + "pluggableDatabaseName": "A String", # Optional. The pluggable database associated with the Database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. "properties": { # The properties of a Database. # Optional. The properties of the Database. "databaseManagementConfig": { # The configuration of the Database Management service. # Output only. The Database Management config. "managementState": "A String", # Output only. The status of the Database Management service. diff --git a/docs/dyn/oracledatabase_v1.projects.locations.dbSystems.html b/docs/dyn/oracledatabase_v1.projects.locations.dbSystems.html index b5972d12c0..f5a4d00d1c 100644 --- a/docs/dyn/oracledatabase_v1.projects.locations.dbSystems.html +++ b/docs/dyn/oracledatabase_v1.projects.locations.dbSystems.html @@ -142,6 +142,8 @@

Method Details

"ncharacterSet": "A String", # Optional. The national character set for the database. The default is AL16UTF16. "ociUrl": "A String", # Output only. HTTPS link to OCI resources exposed to Customer via UI Interface. "opsInsightsStatus": "A String", # Output only. The Status of Operations Insights for this Database. + "pluggableDatabaseId": "A String", # Optional. The ID of the pluggable database associated with the Database. The ID must be unique within the project and location. + "pluggableDatabaseName": "A String", # Optional. The pluggable database associated with the Database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. "properties": { # The properties of a Database. # Optional. The properties of the Database. "databaseManagementConfig": { # The configuration of the Database Management service. # Output only. The Database Management config. "managementState": "A String", # Output only. The status of the Database Management service. @@ -310,6 +312,8 @@

Method Details

"ncharacterSet": "A String", # Optional. The national character set for the database. The default is AL16UTF16. "ociUrl": "A String", # Output only. HTTPS link to OCI resources exposed to Customer via UI Interface. "opsInsightsStatus": "A String", # Output only. The Status of Operations Insights for this Database. + "pluggableDatabaseId": "A String", # Optional. The ID of the pluggable database associated with the Database. The ID must be unique within the project and location. + "pluggableDatabaseName": "A String", # Optional. The pluggable database associated with the Database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. "properties": { # The properties of a Database. # Optional. The properties of the Database. "databaseManagementConfig": { # The configuration of the Database Management service. # Output only. The Database Management config. "managementState": "A String", # Output only. The status of the Database Management service. @@ -418,6 +422,8 @@

Method Details

"ncharacterSet": "A String", # Optional. The national character set for the database. The default is AL16UTF16. "ociUrl": "A String", # Output only. HTTPS link to OCI resources exposed to Customer via UI Interface. "opsInsightsStatus": "A String", # Output only. The Status of Operations Insights for this Database. + "pluggableDatabaseId": "A String", # Optional. The ID of the pluggable database associated with the Database. The ID must be unique within the project and location. + "pluggableDatabaseName": "A String", # Optional. The pluggable database associated with the Database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. "properties": { # The properties of a Database. # Optional. The properties of the Database. "databaseManagementConfig": { # The configuration of the Database Management service. # Output only. The Database Management config. "managementState": "A String", # Output only. The status of the Database Management service. diff --git a/googleapiclient/discovery_cache/documents/oracledatabase.v1.json b/googleapiclient/discovery_cache/documents/oracledatabase.v1.json index e695e8cb8f..f65f1f3a25 100644 --- a/googleapiclient/discovery_cache/documents/oracledatabase.v1.json +++ b/googleapiclient/discovery_cache/documents/oracledatabase.v1.json @@ -2549,7 +2549,7 @@ } } }, -"revision": "20260220", +"revision": "20260225", "rootUrl": "https://oracledatabase.googleapis.com/", "schemas": { "AllConnectionStrings": { @@ -4361,6 +4361,14 @@ "readOnly": true, "type": "string" }, +"pluggableDatabaseId": { +"description": "Optional. The ID of the pluggable database associated with the Database. The ID must be unique within the project and location.", +"type": "string" +}, +"pluggableDatabaseName": { +"description": "Optional. The pluggable database associated with the Database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters.", +"type": "string" +}, "properties": { "$ref": "DatabaseProperties", "description": "Optional. The properties of the Database." From 3c77a40a6bcc3abfa8777cd786ed99dbc626d22a Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 10 Mar 2026 07:24:07 +0000 Subject: [PATCH 25/31] feat(playdeveloperreporting): update the api #### playdeveloperreporting:v1alpha1 The following keys were deleted: - schemas.ApiservingMcpMcpToolDataHandlingProfile (Total Keys: 4) #### playdeveloperreporting:v1beta1 The following keys were deleted: - schemas.ApiservingMcpMcpToolDataHandlingProfile (Total Keys: 4) --- .../playdeveloperreporting.v1alpha1.json | 53 +------------------ .../playdeveloperreporting.v1beta1.json | 53 +------------------ 2 files changed, 2 insertions(+), 104 deletions(-) diff --git a/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json b/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json index a958840d2d..14985ab0dc 100644 --- a/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json @@ -1004,60 +1004,9 @@ } } }, -"revision": "20260222", +"revision": "20260305", "rootUrl": "https://playdeveloperreporting.googleapis.com/", "schemas": { -"ApiservingMcpMcpToolDataHandlingProfile": { -"description": "Profile describing the data handling characteristics of an MCP tool. When used within the McpTool.meta field, this message should be packed into a google.protobuf.Any and associated with the key: \"google.com/tool.profiles/data_handling\"", -"id": "ApiservingMcpMcpToolDataHandlingProfile", -"properties": { -"inputDataAccessLevel": { -"description": "// The data access level of the tool's inputs.", -"enum": [ -"DATA_ACCESS_LEVEL_UNSPECIFIED", -"DATA_ACCESS_LEVEL_PUBLIC", -"DATA_ACCESS_LEVEL_CONFIDENTIAL", -"DATA_ACCESS_LEVEL_NEED_TO_KNOW", -"DATA_ACCESS_LEVEL_PII", -"DATA_ACCESS_LEVEL_USER", -"DATA_ACCESS_LEVEL_NO_DATA_ACCESS" -], -"enumDescriptions": [ -"The default value. This value is unused.", -"Public data.", -"Confidential data.", -"Need-to-know data.", -"Personally Identifiable Information (PII) data.", -"User data.", -"The tool does not access any data." -], -"type": "string" -}, -"outputDataAccessLevel": { -"description": "The data access level of the tool's outputs.", -"enum": [ -"DATA_ACCESS_LEVEL_UNSPECIFIED", -"DATA_ACCESS_LEVEL_PUBLIC", -"DATA_ACCESS_LEVEL_CONFIDENTIAL", -"DATA_ACCESS_LEVEL_NEED_TO_KNOW", -"DATA_ACCESS_LEVEL_PII", -"DATA_ACCESS_LEVEL_USER", -"DATA_ACCESS_LEVEL_NO_DATA_ACCESS" -], -"enumDescriptions": [ -"The default value. This value is unused.", -"Public data.", -"Confidential data.", -"Need-to-know data.", -"Personally Identifiable Information (PII) data.", -"User data.", -"The tool does not access any data." -], -"type": "string" -} -}, -"type": "object" -}, "GooglePlayDeveloperReportingV1alpha1Anomaly": { "description": "Represents an anomaly detected in a dataset. Our anomaly detection systems flag datapoints in a time series that fall outside of and expected range derived from historical data. Although those expected ranges have an upper and a lower bound, we only flag anomalies when the data has become unexpectedly _worse_, which usually corresponds to the case where the metric crosses the upper bound. Multiple contiguous datapoints in a timeline outside of the expected range will be grouped into a single anomaly. Therefore, an anomaly represents effectively a segment of a metric's timeline. The information stored in the `timeline_spec`, `dimensions` and `metric` can be used to fetch a full timeline with extended ragne for context. **Required permissions**: to access this resource, the calling user needs the _View app information (read-only)_ permission for the app.", "id": "GooglePlayDeveloperReportingV1alpha1Anomaly", diff --git a/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json b/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json index 09aeaacc9a..354a5b7229 100644 --- a/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json @@ -1004,60 +1004,9 @@ } } }, -"revision": "20260222", +"revision": "20260305", "rootUrl": "https://playdeveloperreporting.googleapis.com/", "schemas": { -"ApiservingMcpMcpToolDataHandlingProfile": { -"description": "Profile describing the data handling characteristics of an MCP tool. When used within the McpTool.meta field, this message should be packed into a google.protobuf.Any and associated with the key: \"google.com/tool.profiles/data_handling\"", -"id": "ApiservingMcpMcpToolDataHandlingProfile", -"properties": { -"inputDataAccessLevel": { -"description": "// The data access level of the tool's inputs.", -"enum": [ -"DATA_ACCESS_LEVEL_UNSPECIFIED", -"DATA_ACCESS_LEVEL_PUBLIC", -"DATA_ACCESS_LEVEL_CONFIDENTIAL", -"DATA_ACCESS_LEVEL_NEED_TO_KNOW", -"DATA_ACCESS_LEVEL_PII", -"DATA_ACCESS_LEVEL_USER", -"DATA_ACCESS_LEVEL_NO_DATA_ACCESS" -], -"enumDescriptions": [ -"The default value. This value is unused.", -"Public data.", -"Confidential data.", -"Need-to-know data.", -"Personally Identifiable Information (PII) data.", -"User data.", -"The tool does not access any data." -], -"type": "string" -}, -"outputDataAccessLevel": { -"description": "The data access level of the tool's outputs.", -"enum": [ -"DATA_ACCESS_LEVEL_UNSPECIFIED", -"DATA_ACCESS_LEVEL_PUBLIC", -"DATA_ACCESS_LEVEL_CONFIDENTIAL", -"DATA_ACCESS_LEVEL_NEED_TO_KNOW", -"DATA_ACCESS_LEVEL_PII", -"DATA_ACCESS_LEVEL_USER", -"DATA_ACCESS_LEVEL_NO_DATA_ACCESS" -], -"enumDescriptions": [ -"The default value. This value is unused.", -"Public data.", -"Confidential data.", -"Need-to-know data.", -"Personally Identifiable Information (PII) data.", -"User data.", -"The tool does not access any data." -], -"type": "string" -} -}, -"type": "object" -}, "GooglePlayDeveloperReportingV1beta1Anomaly": { "description": "Represents an anomaly detected in a dataset. Our anomaly detection systems flag datapoints in a time series that fall outside of and expected range derived from historical data. Although those expected ranges have an upper and a lower bound, we only flag anomalies when the data has become unexpectedly _worse_, which usually corresponds to the case where the metric crosses the upper bound. Multiple contiguous datapoints in a timeline outside of the expected range will be grouped into a single anomaly. Therefore, an anomaly represents effectively a segment of a metric's timeline. The information stored in the `timeline_spec`, `dimensions` and `metric` can be used to fetch a full timeline with extended ragne for context. **Required permissions**: to access this resource, the calling user needs the _View app information (read-only)_ permission for the app.", "id": "GooglePlayDeveloperReportingV1beta1Anomaly", From 355d7bb22673271ec4589a7865e15ccb90a86da8 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 10 Mar 2026 07:24:07 +0000 Subject: [PATCH 26/31] feat(recaptchaenterprise): update the api #### recaptchaenterprise:v1 The following keys were added: - schemas.GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment.properties.accountTakeoverVerdict (Total Keys: 2) - schemas.GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessmentAccountRiskReason (Total Keys: 4) - schemas.GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessmentAccountTakeoverVerdict (Total Keys: 11) - schemas.GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessmentAccountTrustReason (Total Keys: 4) --- ...chaenterprise_v1.projects.assessments.html | 30 ++++++- .../documents/recaptchaenterprise.v1.json | 86 ++++++++++++++++++- 2 files changed, 111 insertions(+), 5 deletions(-) diff --git a/docs/dyn/recaptchaenterprise_v1.projects.assessments.html b/docs/dyn/recaptchaenterprise_v1.projects.assessments.html index 3c18f42edf..29abcf3a29 100644 --- a/docs/dyn/recaptchaenterprise_v1.projects.assessments.html +++ b/docs/dyn/recaptchaenterprise_v1.projects.assessments.html @@ -140,6 +140,19 @@

Method Details

{ # A reCAPTCHA Enterprise assessment resource. "accountDefenderAssessment": { # Account defender risk assessment. # Output only. Assessment returned by account defender when an account identifier is provided. + "accountTakeoverVerdict": { # Account takeover risk assessment. # Output only. Account takeover risk assessment for this request. + "risk": 3.14, # Output only. Account takeover attempt probability. Values are from 0.0 (lowest risk) to 1.0 (highest risk). + "riskReasons": [ # Output only. Unordered list. Reasons why the request appears risky. Risk reasons can be returned even if the risk is low, as trustworthy requests can still have some risk signals. + { # Risk explainability reasons for account defender. + "reason": "A String", # Output only. A risk reason associated with this request. + }, + ], + "trustReasons": [ # Output only. Unordered list. Reasons why the request appears trustworthy. Trust reasons can be returned even if the risk is high, as risky requests can still have some trust signals. + { # Trust explainability reasons for account defender. + "reason": "A String", # Output only. A trust reason associated with this request. + }, + ], + }, "labels": [ # Output only. Labels for this request. "A String", ], @@ -334,7 +347,7 @@

Method Details

}, "riskAnalysis": { # Risk analysis result for an event. # Output only. The risk analysis result for the event being assessed. "challenge": "A String", # Output only. Challenge information for POLICY_BASED_CHALLENGE and INVISIBLE keys. - "extendedVerdictReasons": [ # Output only. Extended verdict reasons to be used for experimentation only. The set of possible reasons is subject to change. + "extendedVerdictReasons": [ # Output only. Advanced reasons contributing to the risk analysis verdict. These reasons are available to Enterprise tier projects only. Contact sales for more information. The set of possible reasons is subject to change. "A String", ], "reasons": [ # Output only. Reasons contributing to the risk analysis verdict. @@ -369,6 +382,19 @@

Method Details

{ # A reCAPTCHA Enterprise assessment resource. "accountDefenderAssessment": { # Account defender risk assessment. # Output only. Assessment returned by account defender when an account identifier is provided. + "accountTakeoverVerdict": { # Account takeover risk assessment. # Output only. Account takeover risk assessment for this request. + "risk": 3.14, # Output only. Account takeover attempt probability. Values are from 0.0 (lowest risk) to 1.0 (highest risk). + "riskReasons": [ # Output only. Unordered list. Reasons why the request appears risky. Risk reasons can be returned even if the risk is low, as trustworthy requests can still have some risk signals. + { # Risk explainability reasons for account defender. + "reason": "A String", # Output only. A risk reason associated with this request. + }, + ], + "trustReasons": [ # Output only. Unordered list. Reasons why the request appears trustworthy. Trust reasons can be returned even if the risk is high, as risky requests can still have some trust signals. + { # Trust explainability reasons for account defender. + "reason": "A String", # Output only. A trust reason associated with this request. + }, + ], + }, "labels": [ # Output only. Labels for this request. "A String", ], @@ -563,7 +589,7 @@

Method Details

}, "riskAnalysis": { # Risk analysis result for an event. # Output only. The risk analysis result for the event being assessed. "challenge": "A String", # Output only. Challenge information for POLICY_BASED_CHALLENGE and INVISIBLE keys. - "extendedVerdictReasons": [ # Output only. Extended verdict reasons to be used for experimentation only. The set of possible reasons is subject to change. + "extendedVerdictReasons": [ # Output only. Advanced reasons contributing to the risk analysis verdict. These reasons are available to Enterprise tier projects only. Contact sales for more information. The set of possible reasons is subject to change. "A String", ], "reasons": [ # Output only. Reasons contributing to the risk analysis verdict. diff --git a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json index 2928f7e492..21e6238d4a 100644 --- a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +++ b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json @@ -786,13 +786,18 @@ } } }, -"revision": "20251201", +"revision": "20260302", "rootUrl": "https://recaptchaenterprise.googleapis.com/", "schemas": { "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment": { "description": "Account defender risk assessment.", "id": "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment", "properties": { +"accountTakeoverVerdict": { +"$ref": "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessmentAccountTakeoverVerdict", +"description": "Output only. Account takeover risk assessment for this request.", +"readOnly": true +}, "labels": { "description": "Output only. Labels for this request.", "items": { @@ -805,7 +810,7 @@ ], "enumDescriptions": [ "Default unspecified type.", -"The request matches a known good profile for the user.", +"The request matches a trusted profile associated with this account.", "The request is potentially a suspicious login event and must be further verified either through multi-factor authentication or another system.", "The request matched a profile that previously had suspicious account creation behavior. This can mean that this is a fake account.", "The account in the request has a high number of related accounts. It does not necessarily imply that the account is bad but can require further investigation." @@ -818,6 +823,81 @@ }, "type": "object" }, +"GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessmentAccountRiskReason": { +"description": "Risk explainability reasons for account defender.", +"id": "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessmentAccountRiskReason", +"properties": { +"reason": { +"description": "Output only. A risk reason associated with this request.", +"enum": [ +"RISK_REASON_UNSPECIFIED", +"CLIENT_HISTORICAL_BOT_ACTIVITY", +"ACCOUNT_IN_LARGE_RELATED_GROUP", +"CLIENT_ACCESSED_MANY_ACCOUNTS" +], +"enumDescriptions": [ +"Default unspecified type.", +"The client has been observed sending bot-like traffic to this site in the past. This reason incorporates historical reputation and indicates that the client is known to use bots, even if the current request is being made by a human.", +"The account is part of a large group of related accounts, indicating that it may be part of a fraudulent network. Related accounts are identified based on having similar traffic patterns and request characteristics.", +"The client has been observed accessing many accounts on this site." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessmentAccountTakeoverVerdict": { +"description": "Account takeover risk assessment.", +"id": "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessmentAccountTakeoverVerdict", +"properties": { +"risk": { +"description": "Output only. Account takeover attempt probability. Values are from 0.0 (lowest risk) to 1.0 (highest risk).", +"format": "float", +"readOnly": true, +"type": "number" +}, +"riskReasons": { +"description": "Output only. Unordered list. Reasons why the request appears risky. Risk reasons can be returned even if the risk is low, as trustworthy requests can still have some risk signals.", +"items": { +"$ref": "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessmentAccountRiskReason" +}, +"readOnly": true, +"type": "array" +}, +"trustReasons": { +"description": "Output only. Unordered list. Reasons why the request appears trustworthy. Trust reasons can be returned even if the risk is high, as risky requests can still have some trust signals.", +"items": { +"$ref": "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessmentAccountTrustReason" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessmentAccountTrustReason": { +"description": "Trust explainability reasons for account defender.", +"id": "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessmentAccountTrustReason", +"properties": { +"reason": { +"description": "Output only. A trust reason associated with this request.", +"enum": [ +"TRUST_REASON_UNSPECIFIED", +"PROFILE_MATCH", +"ACCOUNT_HISTORY_REPUTABLE" +], +"enumDescriptions": [ +"Default unspecified type.", +"The request matches a trusted profile associated with this account. Equivalent to `AccountDefenderLabel.PROFILE_MATCH`.", +"The account's historical activity is reputable. It is unlikely that the account has been compromised in the past." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo": { "description": "Information about account verification, used for identity verification.", "id": "GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo", @@ -1959,7 +2039,7 @@ true "type": "string" }, "extendedVerdictReasons": { -"description": "Output only. Extended verdict reasons to be used for experimentation only. The set of possible reasons is subject to change.", +"description": "Output only. Advanced reasons contributing to the risk analysis verdict. These reasons are available to Enterprise tier projects only. Contact sales for more information. The set of possible reasons is subject to change.", "items": { "type": "string" }, From fbce7ae38485e51dcf27a51802db73356b9ad990 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 10 Mar 2026 07:24:07 +0000 Subject: [PATCH 27/31] feat(sqladmin): update the api #### sqladmin:v1 The following keys were added: - schemas.PointInTimeRestoreContext.properties.region.type (Total Keys: 1) - schemas.PointInTimeRestoreContext.properties.targetInstanceClearSettingsFieldNames (Total Keys: 2) - schemas.PointInTimeRestoreContext.properties.targetInstanceSettings.$ref (Total Keys: 1) #### sqladmin:v1beta4 The following keys were added: - schemas.PointInTimeRestoreContext.properties.region.type (Total Keys: 1) - schemas.PointInTimeRestoreContext.properties.targetInstanceClearSettingsFieldNames (Total Keys: 2) - schemas.PointInTimeRestoreContext.properties.targetInstanceSettings.$ref (Total Keys: 1) --- docs/dyn/sqladmin_v1.instances.html | 384 ++++++++++++++++++ docs/dyn/sqladmin_v1beta4.instances.html | 384 ++++++++++++++++++ .../documents/sqladmin.v1.json | 17 +- .../documents/sqladmin.v1beta4.json | 17 +- 4 files changed, 800 insertions(+), 2 deletions(-) diff --git a/docs/dyn/sqladmin_v1.instances.html b/docs/dyn/sqladmin_v1.instances.html index f08b60ff73..1cff704dc3 100644 --- a/docs/dyn/sqladmin_v1.instances.html +++ b/docs/dyn/sqladmin_v1.instances.html @@ -4517,7 +4517,391 @@

Method Details

"preferredSecondaryZone": "A String", # Optional. Point-in-time recovery of a regional instance in the specified zones. If not specified, clone to the same secondary zone as the source instance. This value cannot be the same as the preferred_zone field. "preferredZone": "A String", # Optional. Point-in-time recovery of an instance to the specified zone. If no zone is specified, then clone to the same primary zone as the source instance. "privateNetwork": "A String", # Optional. The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, `/projects/myProject/global/networks/default`. + "region": "A String", # Optional. The region of the target instance where the datasource will be restored. For example: "us-central1". "targetInstance": "A String", # Target instance name. + "targetInstanceClearSettingsFieldNames": [ # Optional. Specifies the instance settings that will be cleared from the source instance. This field is only applicable for cross project PITRs. + "A String", + ], + "targetInstanceSettings": { # A Cloud SQL instance resource. # Optional. Specifies the instance settings that will be overridden from the source instance. This field is only applicable for cross project PITRs. + "availableMaintenanceVersions": [ # Output only. List all maintenance versions applicable on the instance + "A String", + ], + "backendType": "A String", # The backend type. `SECOND_GEN`: Cloud SQL database instance. `EXTERNAL`: A database server that is not managed by Google. This property is read-only; use the `tier` property in the `settings` object to determine the database type. + "connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. + "createTime": "A String", # Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. + "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for details. + "databaseInstalledVersion": "A String", # Output only. Stores the current database version running on the instance including minor version such as `MYSQL_8_0_18`. + "databaseVersion": "A String", # The database engine type and version. The `databaseVersion` field cannot be changed after instance creation. + "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. + "kind": "A String", # This is always `sql#diskEncryptionConfiguration`. + "kmsKeyName": "A String", # Resource name of KMS key for disk encryption + }, + "diskEncryptionStatus": { # Disk encryption status for an instance. # Disk encryption status specific to an instance. + "kind": "A String", # This is always `sql#diskEncryptionStatus`. + "kmsKeyVersionName": "A String", # KMS key version used to encrypt the Cloud SQL instance resource + }, + "dnsName": "A String", # Output only. The dns name of the instance. + "dnsNames": [ # Output only. The list of DNS names used by this instance. + { # DNS metadata. + "connectionType": "A String", # Output only. The connection type of the DNS name. + "dnsScope": "A String", # Output only. The scope that the DNS name applies to. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. + }, + ], + "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead. + "failoverReplica": { # The name and status of the failover replica. + "available": True or False, # The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only failover to the failover replica when the status is true. + "name": "A String", # The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID. + }, + "gceZone": "A String", # The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance. + "geminiConfig": { # Gemini instance configuration. # Gemini instance configuration. + "activeQueryEnabled": True or False, # Output only. Whether the active query is enabled. + "entitled": True or False, # Output only. Whether Gemini is enabled. + "flagRecommenderEnabled": True or False, # Output only. Whether the flag recommender is enabled. + "googleVacuumMgmtEnabled": True or False, # Output only. Whether the vacuum management is enabled. + "indexAdvisorEnabled": True or False, # Output only. Whether the index advisor is enabled. + "oomSessionCancelEnabled": True or False, # Output only. Whether canceling the out-of-memory (OOM) session is enabled. + }, + "includeReplicasForMajorVersionUpgrade": True or False, # Input only. Determines whether an in-place major version upgrade of replicas happens when an in-place major version upgrade of a primary instance is initiated. + "instanceType": "A String", # The instance type. + "ipAddresses": [ # The assigned IP addresses for the instance. + { # Database instance IP mapping + "ipAddress": "A String", # The IP address assigned. + "timeToRetire": "A String", # The due time for this IP to be retired in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. This field is only available when the IP is scheduled to be retired. + "type": "A String", # The type of this IP address. A `PRIMARY` address is a public address that can accept incoming connections. A `PRIVATE` address is a private address that can accept incoming connections. An `OUTGOING` address is the source address of connections originating from the instance, if supported. + }, + ], + "ipv6Address": "A String", # The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances. + "kind": "A String", # This is always `sql#instance`. + "maintenanceVersion": "A String", # The current software version on the instance. + "masterInstanceName": "A String", # The name of the instance which will act as primary in the replication setup. + "maxDiskSize": "A String", # The maximum disk size of the instance in bytes. + "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID. + "nodeCount": 42, # The number of read pool nodes in a read pool. + "nodes": [ # Output only. Entries containing information about each read pool node of the read pool. + { # Details of a single read pool node of a read pool. + "dnsName": "A String", # Output only. The DNS name of the read pool node. + "dnsNames": [ # Output only. The list of DNS names used by this read pool node. + { # DNS metadata. + "connectionType": "A String", # Output only. The connection type of the DNS name. + "dnsScope": "A String", # Output only. The scope that the DNS name applies to. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. + }, + ], + "gceZone": "A String", # Output only. The zone of the read pool node. + "ipAddresses": [ # Output only. Mappings containing IP addresses that can be used to connect to the read pool node. + { # Database instance IP mapping + "ipAddress": "A String", # The IP address assigned. + "timeToRetire": "A String", # The due time for this IP to be retired in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. This field is only available when the IP is scheduled to be retired. + "type": "A String", # The type of this IP address. A `PRIMARY` address is a public address that can accept incoming connections. A `PRIVATE` address is a private address that can accept incoming connections. An `OUTGOING` address is the source address of connections originating from the instance, if supported. + }, + ], + "name": "A String", # Output only. The name of the read pool node, to be used for retrieving metrics and logs. + "pscAutoConnections": [ # Output only. The list of settings for requested automatically-setup Private Service Connect (PSC) consumer endpoints that can be used to connect to this read pool node. + { # Settings for an automatically-setup Private Service Connect consumer endpoint that is used to connect to a Cloud SQL instance. + "consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. + "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. + "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. Optional. This is only applicable if consumer_network is a shared vpc network. + "ipAddress": "A String", # The IP address of the consumer endpoint. + "status": "A String", # The connection status of the consumer endpoint. + }, + ], + "pscServiceAttachmentLink": "A String", # Output only. The Private Service Connect (PSC) service attachment of the read pool node. + "state": "A String", # Output only. The current state of the read pool node. + }, + ], + "onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances. + "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. + "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. + "clientKey": "A String", # PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. + "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica. + "hostPort": "A String", # The host and port of the on-premises instance in host:port format + "kind": "A String", # This is always `sql#onPremisesConfiguration`. + "password": "A String", # The password for connecting to on-premises instance. + "selectedObjects": [ # Optional. A list of objects that the user selects for replication from an external source instance. + { # A list of objects that the user selects for replication from an external source instance. + "database": "A String", # Required. The name of the database to migrate. + }, + ], + "sourceInstance": { # Reference to another Cloud SQL instance. # The reference to Cloud SQL instance if the source is Cloud SQL. + "name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID. + "project": "A String", # The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it. + "region": "A String", # The region of the Cloud SQL instance being referenced. + }, + "sslOption": "A String", # Optional. SSL option for replica connection to the on-premises source. + "username": "A String", # The username for connecting to on-premises instance. + }, + "outOfDiskReport": { # This message wraps up the information written by out-of-disk detection job. # This field represents the report generated by the proactive database wellness job for OutOfDisk issues. * Writers: * the proactive database wellness job for OOD. * Readers: * the proactive database wellness job + "sqlMinRecommendedIncreaseSizeGb": 42, # The minimum recommended increase size in GigaBytes This field is consumed by the frontend * Writers: * the proactive database wellness job for OOD. * Readers: + "sqlOutOfDiskState": "A String", # This field represents the state generated by the proactive database wellness job for OutOfDisk issues. * Writers: * the proactive database wellness job for OOD. * Readers: * the proactive database wellness job + }, + "primaryDnsName": "A String", # Output only. DEPRECATED: please use write_endpoint instead. + "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. + "pscServiceAttachmentLink": "A String", # Output only. The link to service attachment of PSC instance. + "region": "A String", # The geographical region of the Cloud SQL instance. It can be one of the [regions](https://cloud.google.com/sql/docs/mysql/locations#location-r) where Cloud SQL operates: For example, `asia-east1`, `europe-west1`, and `us-central1`. The default value is `us-central1`. + "replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas. + "cascadableReplica": True or False, # Optional. Specifies if a SQL Server replica is a cascadable replica. A cascadable replica is a SQL Server cross region replica that supports replica(s) under it. + "failoverTarget": True or False, # Specifies if the replica is the failover target. If the field is set to `true`, the replica will be designated as a failover replica. In case the primary instance fails, the replica instance will be promoted as the new primary instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the primary instance. + "kind": "A String", # This is always `sql#replicaConfiguration`. + "mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # MySQL specific configuration when replicating from a MySQL on-premises primary instance. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named `master.info` in the data directory. + "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. + "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. + "clientKey": "A String", # PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. + "connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds. + "dumpFilePath": "A String", # Path to a SQL dump file in Google Cloud Storage from which the replica instance is to be created. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported. Dumps have the binlog co-ordinates from which replication begins. This can be accomplished by setting --master-data to 1 when using mysqldump. + "kind": "A String", # This is always `sql#mysqlReplicaConfiguration`. + "masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats. + "password": "A String", # The password for the replication connection. + "sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption. + "username": "A String", # The username for the replication connection. + "verifyServerCertificate": True or False, # Whether or not to check the primary instance's Common Name value in the certificate that it sends during the SSL handshake. + }, + }, + "replicaNames": [ # The replicas of the instance. + "A String", + ], + "replicationCluster": { # A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional failure. Applicable to MySQL and PostgreSQL. # Optional. A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional failure. Applicable to MySQL and PostgreSQL. + "drReplica": True or False, # Output only. Read-only field that indicates whether the replica is a DR replica. This field is not set if the instance is a primary instance. + "failoverDrReplicaName": "A String", # Optional. If the instance is a primary instance, then this field identifies the disaster recovery (DR) replica. A DR replica is an optional configuration for Enterprise Plus edition instances. If the instance is a read replica, then the field is not set. Set this field to a replica name to designate a DR replica for a primary instance. Remove the replica name to remove the DR replica designation. + "psaWriteEndpoint": "A String", # Output only. If set, this field indicates this instance has a private service access (PSA) DNS endpoint that is pointing to the primary instance of the cluster. If this instance is the primary, then the DNS endpoint points to this instance. After a switchover or replica failover operation, this DNS endpoint points to the promoted instance. This is a read-only field, returned to the user as information. This field can exist even if a standalone instance doesn't have a DR replica yet or the DR replica is deleted. + }, + "rootPassword": "A String", # Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances. + "satisfiesPzi": True or False, # Output only. This status indicates whether the instance satisfies PZI. The status is reserved for future use. + "satisfiesPzs": True or False, # This status indicates whether the instance satisfies PZS. The status is reserved for future use. + "scheduledMaintenance": { # Any scheduled maintenance for this instance. # The start time of any upcoming scheduled maintenance for this instance. + "canDefer": True or False, + "canReschedule": True or False, # If the scheduled maintenance can be rescheduled. + "scheduleDeadlineTime": "A String", # Maintenance cannot be rescheduled to start beyond this deadline. + "startTime": "A String", # The start time of any upcoming scheduled maintenance for this instance. + }, + "secondaryGceZone": "A String", # The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone. + "selfLink": "A String", # The URI of this resource. + "serverCaCert": { # SslCerts Resource # SSL configuration. + "cert": "A String", # PEM representation. + "certSerialNumber": "A String", # Serial number, as extracted from the certificate. + "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+. + "createTime": "A String", # The time when the certificate was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z` + "expirationTime": "A String", # The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. + "instance": "A String", # Name of the database instance. + "kind": "A String", # This is always `sql#sslCert`. + "selfLink": "A String", # The URI of this resource. + "sha1Fingerprint": "A String", # Sha1 Fingerprint. + }, + "serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance.\This property is read-only. + "settings": { # Database instance settings. # The user settings. + "acceleratedReplicaMode": True or False, # Optional. Whether the replica is in accelerated mode. This feature is in private preview and requires allowlisting to take effect. + "activationPolicy": "A String", # The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE. Valid values: * `ALWAYS`: The instance is on, and remains so even in the absence of connection requests. * `NEVER`: The instance is off; it is not activated, even if a connection request arrives. + "activeDirectoryConfig": { # Active Directory configuration, relevant only for Cloud SQL for SQL Server. # Active Directory configuration, relevant only for Cloud SQL for SQL Server. + "adminCredentialSecretName": "A String", # Optional. The secret manager key storing the administrator credential. (e.g., projects/{project}/secrets/{secret}). + "dnsServers": [ # Optional. Domain controller IPv4 addresses used to bootstrap Active Directory. + "A String", + ], + "domain": "A String", # The name of the domain (e.g., mydomain.com). + "kind": "A String", # This is always sql#activeDirectoryConfig. + "mode": "A String", # Optional. The mode of the Active Directory configuration. + "organizationalUnit": "A String", # Optional. The organizational unit distinguished name. This is the full hierarchical path to the organizational unit. + }, + "advancedMachineFeatures": { # Specifies options for controlling advanced machine features. # Specifies advanced machine configuration for the instances relevant only for SQL Server. + "threadsPerCore": 42, # The number of threads per physical core. + }, + "authorizedGaeApplications": [ # The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only. + "A String", + ], + "autoUpgradeEnabled": True or False, # Optional. Cloud SQL for MySQL auto-upgrade configuration. When this parameter is set to true, auto-upgrade is enabled for MySQL 8.0 minor versions. The MySQL version must be 8.0.35 or higher. + "availabilityType": "A String", # Availability type. Potential values: * `ZONAL`: The instance serves data from only one zone. Outages in that zone affect data accessibility. * `REGIONAL`: The instance can serve data from more than one zone in a region (it is highly available)./ For more information, see [Overview of the High Availability Configuration](https://cloud.google.com/sql/docs/mysql/high-availability). + "backupConfiguration": { # Database instance backup configuration. # The daily backup configuration for the instance. + "backupRetentionSettings": { # We currently only support backup retention by specifying the number of backups we will retain. # Backup retention settings. + "retainedBackups": 42, # Depending on the value of retention_unit, this is used to determine if a backup needs to be deleted. If retention_unit is 'COUNT', we will retain this many backups. + "retentionUnit": "A String", # The unit that 'retained_backups' represents. + }, + "backupTier": "A String", # Output only. Backup tier that manages the backups for the instance. + "binaryLogEnabled": True or False, # (MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well. + "enabled": True or False, # Whether this configuration is enabled. + "kind": "A String", # This is always `sql#backupConfiguration`. + "location": "A String", # Location of the backup + "pointInTimeRecoveryEnabled": True or False, # Whether point in time recovery is enabled. + "replicationLogArchivingEnabled": True or False, # Reserved for future use. + "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - `HH:MM`. + "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7. + "transactionalLogStorageState": "A String", # Output only. This value contains the storage location of transactional logs used to perform point-in-time recovery (PITR) for the database. + }, + "collation": "A String", # The name of server Instance collation. + "connectionPoolConfig": { # The managed connection pooling configuration. # Optional. The managed connection pooling configuration for the instance. + "connectionPoolingEnabled": True or False, # Whether managed connection pooling is enabled. + "flags": [ # Optional. List of connection pool configuration flags. + { # Connection pool flags for Cloud SQL instances managed connection pool configuration. + "name": "A String", # Required. The name of the flag. + "value": "A String", # Required. The value of the flag. Boolean flags are set to `on` for true and `off` for false. This field must be omitted if the flag doesn't take a value. + }, + ], + "poolerCount": 42, # Output only. Number of connection poolers. + }, + "connectorEnforcement": "A String", # Specifies if connections must use Cloud SQL connectors. Option values include the following: `NOT_REQUIRED` (Cloud SQL instances can be connected without Cloud SQL Connectors) and `REQUIRED` (Only allow connections that use Cloud SQL Connectors). Note that using REQUIRED disables all existing authorized networks. If this field is not specified when creating a new instance, NOT_REQUIRED is used. If this field is not specified when patching or updating an existing instance, it is left unchanged in the instance. + "crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances. + "dataApiAccess": "A String", # This parameter controls whether to allow using ExecuteSql API to connect to the instance. Not allowed by default. + "dataCacheConfig": { # Data cache configurations. # Configuration for data cache. + "dataCacheEnabled": True or False, # Whether data cache is enabled for the instance. + }, + "dataDiskProvisionedIops": "A String", # Optional. Provisioned number of I/O operations per second for the data disk. This field is only used for hyperdisk-balanced disk types. + "dataDiskProvisionedThroughput": "A String", # Optional. Provisioned throughput measured in MiB per second for the data disk. This field is only used for hyperdisk-balanced disk types. + "dataDiskSizeGb": "A String", # The size of data disk, in GB. The data disk size minimum is 10GB. + "dataDiskType": "A String", # The type of data disk: `PD_SSD` (default) or `PD_HDD`. Not used for First Generation instances. + "databaseFlags": [ # The database flags passed to the instance at startup. + { # Database flags for Cloud SQL instances. + "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both server options and system variables. Flags are specified with underscores, not hyphens. For more information, see [Configuring Database Flags](https://cloud.google.com/sql/docs/mysql/flags) in the Cloud SQL documentation. + "value": "A String", # The value of the flag. Boolean flags are set to `on` for true and `off` for false. This field must be omitted if the flag doesn't take a value. + }, + ], + "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not. WARNING: Changing this restarts the instance. + "deletionProtectionEnabled": True or False, # Configuration to protect against accidental instance deletion. + "denyMaintenancePeriods": [ # Deny maintenance periods + { # Deny maintenance Periods. This specifies a date range during when all CSA rollout will be denied. + "endDate": "A String", # "deny maintenance period" end date. If the year of the end date is empty, the year of the start date also must be empty. In this case, it means the no maintenance interval recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01 + "startDate": "A String", # "deny maintenance period" start date. If the year of the start date is empty, the year of the end date also must be empty. In this case, it means the deny maintenance period recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01 + "time": "A String", # Time in UTC when the "deny maintenance period" starts on start_date and ends on end_date. The time is in format: HH:mm:SS, i.e., 00:00:00 + }, + ], + "edition": "A String", # Optional. The edition of the instance. + "enableDataplexIntegration": True or False, # Optional. By default, Cloud SQL instances have schema extraction disabled for Dataplex. When this parameter is set to true, schema extraction for Dataplex on Cloud SQL instances is activated. + "enableGoogleMlIntegration": True or False, # Optional. When this parameter is set to true, Cloud SQL instances can connect to Vertex AI to pass requests for real-time predictions and insights to the AI. The default value is false. This applies only to Cloud SQL for MySQL and Cloud SQL for PostgreSQL instances. + "entraidConfig": { # SQL Server Entra ID configuration. # Optional. The Microsoft Entra ID configuration for the SQL Server instance. + "applicationId": "A String", # Optional. The application ID for the Entra ID configuration. + "kind": "A String", # Output only. This is always sql#sqlServerEntraIdConfig + "tenantId": "A String", # Optional. The tenant ID for the Entra ID configuration. + }, + "finalBackupConfig": { # Config used to determine the final backup settings for the instance. # Optional. The final backup configuration for the instance. + "enabled": True or False, # Whether the final backup is enabled for the instance. + "retentionDays": 42, # The number of days to retain the final backup after the instance deletion. The final backup will be purged at (time_of_instance_deletion + retention_days). + }, + "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres. + "enhancedQueryInsightsEnabled": True or False, # Optional. Whether enhanced query insights feature is enabled. + "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled. + "queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. Default is 5. + "queryStringLength": 42, # Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query lengths greater than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database. + "recordApplicationTags": True or False, # Whether Query Insights will record application tags from query when enabled. + "recordClientAddress": True or False, # Whether Query Insights will record client address when enabled. + }, + "ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled for Second Generation instances. + "allocatedIpRange": "A String", # The name of the allocated ip range for the private ip Cloud SQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with [RFC 1035](https://tools.ietf.org/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?.` + "authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: `157.197.200.0/24`). + { # An entry for an Access Control list. + "expirationTime": "A String", # The time when this access control entry expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. + "kind": "A String", # This is always `sql#aclEntry`. + "name": "A String", # Optional. A label to identify this entry. + "value": "A String", # The allowlisted value for the access control list. + }, + ], + "customSubjectAlternativeNames": [ # Optional. Custom Subject Alternative Name(SAN)s for a Cloud SQL instance. + "A String", + ], + "enablePrivatePathForGoogleCloudServices": True or False, # Controls connectivity to private IP instances from Google services, such as BigQuery. + "ipv4Enabled": True or False, # Whether the instance is assigned a public IP address or not. + "privateNetwork": "A String", # The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, `/projects/myProject/global/networks/default`. This setting can be updated, but it cannot be removed after it is set. + "pscConfig": { # PSC settings for a Cloud SQL instance. # PSC settings for this instance. + "allowedConsumerProjects": [ # Optional. The list of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects. Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric). + "A String", + ], + "networkAttachmentUri": "A String", # Optional. The network attachment of the consumer network that the Private Service Connect enabled Cloud SQL instance is authorized to connect via PSC interface. format: projects/PROJECT/regions/REGION/networkAttachments/ID + "pscAutoConnections": [ # Optional. The list of settings for requested Private Service Connect consumer endpoints that can be used to connect to this Cloud SQL instance. + { # Settings for an automatically-setup Private Service Connect consumer endpoint that is used to connect to a Cloud SQL instance. + "consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. + "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. + "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. Optional. This is only applicable if consumer_network is a shared vpc network. + "ipAddress": "A String", # The IP address of the consumer endpoint. + "status": "A String", # The connection status of the consumer endpoint. + }, + ], + "pscEnabled": True or False, # Whether PSC connectivity is enabled for this instance. + }, + "requireSsl": True or False, # Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the `require_ssl` flag. + "serverCaMode": "A String", # Specify what type of CA is used for the server certificate. + "serverCaPool": "A String", # Optional. The resource name of the server CA pool for an instance with `CUSTOMER_MANAGED_CAS_CA` as the `server_ca_mode`. Format: projects/{PROJECT}/locations/{REGION}/caPools/{CA_POOL_ID} + "serverCertificateRotationMode": "A String", # Optional. Controls the automatic server certificate rotation feature. This feature is disabled by default. When enabled, the server certificate will be automatically rotated during Cloud SQL scheduled maintenance or self-service maintenance updates up to six months before it expires. This setting can only be set if server_ca_mode is either GOOGLE_MANAGED_CAS_CA or CUSTOMER_MANAGED_CAS_CA. + "sslMode": "A String", # Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections. + }, + "kind": "A String", # This is always `sql#settings`. + "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance is located. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or Compute Engine zone for better performance. App Engine co-location was only applicable to First Generation instances. + "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance. WARNING: Changing this might restart the instance. + "kind": "A String", # This is always `sql#locationPreference`. + "secondaryZone": "A String", # The preferred Compute Engine zone for the secondary/failover (for example: us-central1-a, us-central1-b, etc.). To disable this field, set it to 'no_secondary_zone'. + "zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.). WARNING: Changing this might restart the instance. + }, + "maintenanceWindow": { # Maintenance window. This specifies when a Cloud SQL instance is restarted for system maintenance purposes. # The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes. + "day": 42, # Day of week - `MONDAY`, `TUESDAY`, `WEDNESDAY`, `THURSDAY`, `FRIDAY`, `SATURDAY`, or `SUNDAY`. Specify in the UTC time zone. Returned in output as an integer, 1 to 7, where `1` equals Monday. + "hour": 42, # Hour of day - 0 to 23. Specify in the UTC time zone. + "kind": "A String", # This is always `sql#maintenanceWindow`. + "updateTrack": "A String", # Maintenance timing settings: `canary`, `stable`, or `week5`. For more information, see [About maintenance on Cloud SQL instances](https://cloud.google.com/sql/docs/mysql/maintenance). + }, + "passwordValidationPolicy": { # Database instance local user password validation policy. This message defines the password policy for local database users. When enabled, it enforces constraints on password complexity, length, and reuse. Keep this policy enabled to help prevent unauthorized access. # The local user password validation policy of the instance. + "complexity": "A String", # The complexity of the password. + "disallowCompromisedCredentials": True or False, # This field is deprecated and will be removed in a future version of the API. + "disallowUsernameSubstring": True or False, # Disallow username as a part of the password. + "enablePasswordPolicy": True or False, # Whether to enable the password policy or not. When enabled, passwords must meet complexity requirements. Keep this policy enabled to help prevent unauthorized access. Disabling this policy allows weak passwords. + "minLength": 42, # Minimum number of characters allowed. + "passwordChangeInterval": "A String", # Minimum interval after which the password can be changed. This flag is only supported for PostgreSQL. + "reuseInterval": 42, # Number of previous passwords that cannot be reused. + }, + "performanceCaptureConfig": { # Performance Capture configuration. # Optional. Configuration for Performance Capture, provides diagnostic metrics during high load situations. + "enabled": True or False, # Optional. Enable or disable the Performance Capture feature. + "probeThreshold": 42, # Optional. The minimum number of consecutive readings above threshold that triggers instance state capture. + "probingIntervalSeconds": 42, # Optional. The time interval in seconds between any two probes. + "runningThreadsThreshold": 42, # Optional. The minimum number of server threads running to trigger the capture on primary. + "secondsBehindSourceThreshold": 42, # Optional. The minimum number of seconds replica must be lagging behind primary to trigger capture on replica. + "transactionDurationThreshold": 42, # Optional. The amount of time in seconds that a transaction needs to have been open before the watcher starts recording it. + }, + "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances. + "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance. + "disableScaleIn": True or False, # Indicates whether read pool auto scaling supports scale in operations (removing nodes). + "enabled": True or False, # Indicates whether read pool auto scaling is enabled. + "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained. + "minNodeCount": 42, # Minimum number of read pool nodes to be maintained. + "scaleInCooldownSeconds": 42, # The cooldown period for scale-in operations. + "scaleOutCooldownSeconds": 42, # The cooldown period for scale-out operations. + "targetMetrics": [ # Optional. Target metrics for read pool auto scaling. + { # Target metric for read pool auto scaling. + "metric": "A String", # The metric name to be used for auto scaling. + "targetValue": 3.14, # The target value for the metric. + }, + ], + }, + "replicationLagMaxSeconds": 42, # Optional. Configuration value for recreation of replica after certain replication lag + "replicationType": "A String", # The type of replication this instance uses. This can be either `ASYNCHRONOUS` or `SYNCHRONOUS`. (Deprecated) This property was only applicable to First Generation instances. + "retainBackupsOnDelete": True or False, # Optional. When this parameter is set to true, Cloud SQL retains backups of the instance even after the instance is deleted. The ON_DEMAND backup will be retained until customer deletes the backup or the project. The AUTOMATED backup will be retained based on the backups retention setting. + "settingsVersion": "A String", # The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value. + "sqlServerAuditConfig": { # SQL Server specific audit configuration. # SQL Server specific audit configuration. + "bucket": "A String", # The name of the destination bucket (e.g., gs://mybucket). + "kind": "A String", # This is always sql#sqlServerAuditConfig + "retentionInterval": "A String", # How long to keep generated audit files. + "uploadInterval": "A String", # How often to upload generated audit files. + }, + "storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is true. + "storageAutoResizeLimit": "A String", # The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit. + "tier": "A String", # The tier (or machine type) for this instance, for example `db-custom-1-3840`. WARNING: Changing this restarts the instance. + "timeZone": "A String", # Server timezone, relevant only for Cloud SQL for SQL Server. + "userLabels": { # User-provided labels, represented as a dictionary where each label is a single key value pair. + "a_key": "A String", + }, + }, + "sqlNetworkArchitecture": "A String", + "state": "A String", # The current serving state of the Cloud SQL instance. + "suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. + "A String", + ], + "switchTransactionLogsToCloudStorageEnabled": True or False, # Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage. + "tags": { # Optional. Input only. Immutable. Tag keys and tag values that are bound to this instance. You must represent each item in the map as: `"" : ""`. For example, a single resource can have the following tags: ``` "123/environment": "production", "123/costCenter": "marketing", ``` For more information on tag creation and management, see https://cloud.google.com/resource-manager/docs/tags/tags-overview. + "a_key": "A String", + }, + "upgradableDatabaseVersions": [ # Output only. All database versions that are available for upgrade. + { # An available database version. It can be a major or a minor version. + "displayName": "A String", # The database version's display name. + "majorVersion": "A String", # The version's major version name. + "name": "A String", # The database version name. For MySQL 8.0, this string provides the database major and minor version. + }, + ], + "writeEndpoint": "A String", # Output only. The dns name of the primary instance in a replication group. + }, } x__xgafv: string, V1 error format. diff --git a/docs/dyn/sqladmin_v1beta4.instances.html b/docs/dyn/sqladmin_v1beta4.instances.html index 82370884c4..6a68c06c04 100644 --- a/docs/dyn/sqladmin_v1beta4.instances.html +++ b/docs/dyn/sqladmin_v1beta4.instances.html @@ -4517,7 +4517,391 @@

Method Details

"preferredSecondaryZone": "A String", # Optional. Point-in-time recovery of a regional instance in the specified zones. If not specified, clone to the same secondary zone as the source instance. This value cannot be the same as the preferred_zone field. "preferredZone": "A String", # Optional. Point-in-time recovery of an instance to the specified zone. If no zone is specified, then clone to the same primary zone as the source instance. "privateNetwork": "A String", # Optional. The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, `/projects/myProject/global/networks/default`. + "region": "A String", # Optional. The region of the target instance where the datasource will be restored. For example: "us-central1". "targetInstance": "A String", # Target instance name. + "targetInstanceClearSettingsFieldNames": [ # Optional. Specifies the instance settings that will be cleared from the source instance. This field is only applicable for cross project PITRs. + "A String", + ], + "targetInstanceSettings": { # A Cloud SQL instance resource. # Optional. Specifies the instance settings that will be overridden from the source instance. This field is only applicable for cross project PITRs. + "availableMaintenanceVersions": [ # Output only. List all maintenance versions applicable on the instance + "A String", + ], + "backendType": "A String", # The backend type. `SECOND_GEN`: Cloud SQL database instance. `EXTERNAL`: A database server that is not managed by Google. This property is read-only; use the `tier` property in the `settings` object to determine the database type. + "connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings. + "createTime": "A String", # Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. + "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for details. + "databaseInstalledVersion": "A String", # Output only. Stores the current database version running on the instance including minor version such as `MYSQL_8_0_18`. + "databaseVersion": "A String", # The database engine type and version. The `databaseVersion` field cannot be changed after instance creation. + "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. + "kind": "A String", # This is always `sql#diskEncryptionConfiguration`. + "kmsKeyName": "A String", # Resource name of KMS key for disk encryption + }, + "diskEncryptionStatus": { # Disk encryption status for an instance. # Disk encryption status specific to an instance. + "kind": "A String", # This is always `sql#diskEncryptionStatus`. + "kmsKeyVersionName": "A String", # KMS key version used to encrypt the Cloud SQL instance resource + }, + "dnsName": "A String", # Output only. The dns name of the instance. + "dnsNames": [ # Output only. The list of DNS names used by this instance. + { # DNS metadata. + "connectionType": "A String", # Output only. The connection type of the DNS name. + "dnsScope": "A String", # Output only. The scope that the DNS name applies to. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. + }, + ], + "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead. + "failoverReplica": { # The name and status of the failover replica. + "available": True or False, # The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only failover to the failover replica when the status is true. + "name": "A String", # The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID. + }, + "gceZone": "A String", # The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance. + "geminiConfig": { # Gemini instance configuration. # Gemini instance configuration. + "activeQueryEnabled": True or False, # Output only. Whether the active query is enabled. + "entitled": True or False, # Output only. Whether Gemini is enabled. + "flagRecommenderEnabled": True or False, # Output only. Whether the flag recommender is enabled. + "googleVacuumMgmtEnabled": True or False, # Output only. Whether the vacuum management is enabled. + "indexAdvisorEnabled": True or False, # Output only. Whether the index advisor is enabled. + "oomSessionCancelEnabled": True or False, # Output only. Whether canceling the out-of-memory (OOM) session is enabled. + }, + "includeReplicasForMajorVersionUpgrade": True or False, # Input only. Determines whether an in-place major version upgrade of replicas happens when an in-place major version upgrade of a primary instance is initiated. + "instanceType": "A String", # The instance type. + "ipAddresses": [ # The assigned IP addresses for the instance. + { # Database instance IP mapping + "ipAddress": "A String", # The IP address assigned. + "timeToRetire": "A String", # The due time for this IP to be retired in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. This field is only available when the IP is scheduled to be retired. + "type": "A String", # The type of this IP address. A `PRIMARY` address is a public address that can accept incoming connections. A `PRIVATE` address is a private address that can accept incoming connections. An `OUTGOING` address is the source address of connections originating from the instance, if supported. + }, + ], + "ipv6Address": "A String", # The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances. + "kind": "A String", # This is always `sql#instance`. + "maintenanceVersion": "A String", # The current software version on the instance. + "masterInstanceName": "A String", # The name of the instance which will act as primary in the replication setup. + "maxDiskSize": "A String", # The maximum disk size of the instance in bytes. + "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID. + "nodeCount": 42, # The number of read pool nodes in a read pool. + "nodes": [ # Output only. Entries containing information about each read pool node of the read pool. + { # Details of a single read pool node of a read pool. + "dnsName": "A String", # Output only. The DNS name of the read pool node. + "dnsNames": [ # Output only. The list of DNS names used by this read pool node. + { # DNS metadata. + "connectionType": "A String", # Output only. The connection type of the DNS name. + "dnsScope": "A String", # Output only. The scope that the DNS name applies to. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. + }, + ], + "gceZone": "A String", # Output only. The zone of the read pool node. + "ipAddresses": [ # Output only. Mappings containing IP addresses that can be used to connect to the read pool node. + { # Database instance IP mapping + "ipAddress": "A String", # The IP address assigned. + "timeToRetire": "A String", # The due time for this IP to be retired in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. This field is only available when the IP is scheduled to be retired. + "type": "A String", # The type of this IP address. A `PRIMARY` address is a public address that can accept incoming connections. A `PRIVATE` address is a private address that can accept incoming connections. An `OUTGOING` address is the source address of connections originating from the instance, if supported. + }, + ], + "name": "A String", # Output only. The name of the read pool node, to be used for retrieving metrics and logs. + "pscAutoConnections": [ # Output only. The list of settings for requested automatically-setup Private Service Connect (PSC) consumer endpoints that can be used to connect to this read pool node. + { # Settings for an automatically-setup Private Service Connect consumer endpoint that is used to connect to a Cloud SQL instance. + "consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. + "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. + "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. Optional. This is only applicable if consumer_network is a shared vpc network. + "ipAddress": "A String", # The IP address of the consumer endpoint. + "status": "A String", # The connection status of the consumer endpoint. + }, + ], + "pscServiceAttachmentLink": "A String", # Output only. The Private Service Connect (PSC) service attachment of the read pool node. + "state": "A String", # Output only. The current state of the read pool node. + }, + ], + "onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances. + "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. + "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. + "clientKey": "A String", # PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. + "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica. + "hostPort": "A String", # The host and port of the on-premises instance in host:port format + "kind": "A String", # This is always `sql#onPremisesConfiguration`. + "password": "A String", # The password for connecting to on-premises instance. + "selectedObjects": [ # Optional. A list of objects that the user selects for replication from an external source instance. + { # A list of objects that the user selects for replication from an external source instance. + "database": "A String", # Required. The name of the database to migrate. + }, + ], + "sourceInstance": { # Reference to another Cloud SQL instance. # The reference to Cloud SQL instance if the source is Cloud SQL. + "name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID. + "project": "A String", # The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it. + "region": "A String", # The region of the Cloud SQL instance being referenced. + }, + "sslOption": "A String", # Optional. SslOption for replica connection to the on-premises source. + "username": "A String", # The username for connecting to on-premises instance. + }, + "outOfDiskReport": { # This message wraps up the information written by out-of-disk detection job. # This field represents the report generated by the proactive database wellness job for OutOfDisk issues. * Writers: * the proactive database wellness job for OOD. * Readers: * the proactive database wellness job + "sqlMinRecommendedIncreaseSizeGb": 42, # The minimum recommended increase size in GigaBytes This field is consumed by the frontend * Writers: * the proactive database wellness job for OOD. * Readers: + "sqlOutOfDiskState": "A String", # This field represents the state generated by the proactive database wellness job for OutOfDisk issues. * Writers: * the proactive database wellness job for OOD. * Readers: * the proactive database wellness job + }, + "primaryDnsName": "A String", # Output only. DEPRECATED: please use write_endpoint instead. + "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. + "pscServiceAttachmentLink": "A String", # Output only. The link to service attachment of PSC instance. + "region": "A String", # The geographical region of the Cloud SQL instance. It can be one of the [regions](https://cloud.google.com/sql/docs/mysql/locations#location-r) where Cloud SQL operates: For example, `asia-east1`, `europe-west1`, and `us-central1`. The default value is `us-central1`. + "replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas. + "cascadableReplica": True or False, # Optional. Specifies if a SQL Server replica is a cascadable replica. A cascadable replica is a SQL Server cross region replica that supports replica(s) under it. + "failoverTarget": True or False, # Specifies if the replica is the failover target. If the field is set to `true` the replica will be designated as a failover replica. In case the primary instance fails, the replica instance will be promoted as the new primary instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the primary instance. + "kind": "A String", # This is always `sql#replicaConfiguration`. + "mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # MySQL specific configuration when replicating from a MySQL on-premises primary instance. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named `master.info` in the data directory. + "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate. + "clientCertificate": "A String", # PEM representation of the replica's x509 certificate. + "clientKey": "A String", # PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. + "connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds. + "dumpFilePath": "A String", # Path to a SQL dump file in Google Cloud Storage from which the replica instance is to be created. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported. Dumps have the binlog co-ordinates from which replication begins. This can be accomplished by setting --master-data to 1 when using mysqldump. + "kind": "A String", # This is always `sql#mysqlReplicaConfiguration`. + "masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats. + "password": "A String", # The password for the replication connection. + "sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption. + "username": "A String", # The username for the replication connection. + "verifyServerCertificate": True or False, # Whether or not to check the primary instance's Common Name value in the certificate that it sends during the SSL handshake. + }, + }, + "replicaNames": [ # The replicas of the instance. + "A String", + ], + "replicationCluster": { # A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance has regional failure. Applicable to MySQL and PostgreSQL. # A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional failure. Applicable to MySQL and PostgreSQL. + "drReplica": True or False, # Output only. Read-only field that indicates whether the replica is a DR replica. This field is not set if the instance is a primary instance. + "failoverDrReplicaName": "A String", # Optional. If the instance is a primary instance, then this field identifies the disaster recovery (DR) replica. A DR replica is an optional configuration for Enterprise Plus edition instances. If the instance is a read replica, then the field is not set. Set this field to a replica name to designate a DR replica for a primary instance. Remove the replica name to remove the DR replica designation. + "psaWriteEndpoint": "A String", # Output only. If set, this field indicates this instance has a private service access (PSA) DNS endpoint that is pointing to the primary instance of the cluster. If this instance is the primary, then the DNS endpoint points to this instance. After a switchover or replica failover operation, this DNS endpoint points to the promoted instance. This is a read-only field, returned to the user as information. This field can exist even if a standalone instance doesn't have a DR replica yet or the DR replica is deleted. + }, + "rootPassword": "A String", # Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances. + "satisfiesPzi": True or False, # Output only. This status indicates whether the instance satisfies PZI. The status is reserved for future use. + "satisfiesPzs": True or False, # This status indicates whether the instance satisfies PZS. The status is reserved for future use. + "scheduledMaintenance": { # Any scheduled maintenance for this instance. # The start time of any upcoming scheduled maintenance for this instance. + "canDefer": True or False, + "canReschedule": True or False, # If the scheduled maintenance can be rescheduled. + "scheduleDeadlineTime": "A String", # Maintenance cannot be rescheduled to start beyond this deadline. + "startTime": "A String", # The start time of any upcoming scheduled maintenance for this instance. + }, + "secondaryGceZone": "A String", # The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone. + "selfLink": "A String", # The URI of this resource. + "serverCaCert": { # SslCerts Resource # SSL configuration. + "cert": "A String", # PEM representation. + "certSerialNumber": "A String", # Serial number, as extracted from the certificate. + "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+. + "createTime": "A String", # The time when the certificate was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. + "expirationTime": "A String", # The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. + "instance": "A String", # Name of the database instance. + "kind": "A String", # This is always `sql#sslCert`. + "selfLink": "A String", # The URI of this resource. + "sha1Fingerprint": "A String", # Sha1 Fingerprint. + }, + "serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance. \This property is read-only. + "settings": { # Database instance settings. # The user settings. + "acceleratedReplicaMode": True or False, # Optional. Configures whether the replica is in accelerated mode. This feature is in private preview and requires allowlisting to take effect. + "activationPolicy": "A String", # The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE. Valid values: * `ALWAYS`: The instance is on, and remains so even in the absence of connection requests. * `NEVER`: The instance is off; it is not activated, even if a connection request arrives. + "activeDirectoryConfig": { # Active Directory configuration, relevant only for Cloud SQL for SQL Server. # Active Directory configuration, relevant only for Cloud SQL for SQL Server. + "adminCredentialSecretName": "A String", # Optional. The secret manager key storing the administrator credential. (e.g., projects/{project}/secrets/{secret}). + "dnsServers": [ # Optional. Domain controller IPv4 addresses used to bootstrap Active Directory. + "A String", + ], + "domain": "A String", # The name of the domain (e.g., mydomain.com). + "kind": "A String", # This is always sql#activeDirectoryConfig. + "mode": "A String", # Optional. The mode of the Active Directory configuration. + "organizationalUnit": "A String", # Optional. The organizational unit distinguished name. This is the full hierarchical path to the organizational unit. + }, + "advancedMachineFeatures": { # Specifies options for controlling advanced machine features. # Specifies advanced machine configuration for the instances relevant only for SQL Server. + "threadsPerCore": 42, # The number of threads per physical core. + }, + "authorizedGaeApplications": [ # The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only. + "A String", + ], + "autoUpgradeEnabled": True or False, # Optional. Cloud SQL for MySQL auto-upgrade configuration. When this parameter is set to true, auto-upgrade is enabled for MySQL 8.0 minor versions. The MySQL version must be 8.0.35 or higher. + "availabilityType": "A String", # Availability type. Potential values: * `ZONAL`: The instance serves data from only one zone. Outages in that zone affect data accessibility. * `REGIONAL`: The instance can serve data from more than one zone in a region (it is highly available)./ For more information, see [Overview of the High Availability Configuration](https://cloud.google.com/sql/docs/mysql/high-availability). + "backupConfiguration": { # Database instance backup configuration. # The daily backup configuration for the instance. + "backupRetentionSettings": { # We currently only support backup retention by specifying the number of backups we will retain. # Backup retention settings. + "retainedBackups": 42, # Depending on the value of retention_unit, this is used to determine if a backup needs to be deleted. If retention_unit is 'COUNT', we will retain this many backups. + "retentionUnit": "A String", # The unit that 'retained_backups' represents. + }, + "backupTier": "A String", # Output only. Backup tier that manages the backups for the instance. + "binaryLogEnabled": True or False, # (MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well. + "enabled": True or False, # Whether this configuration is enabled. + "kind": "A String", # This is always `sql#backupConfiguration`. + "location": "A String", # Location of the backup + "pointInTimeRecoveryEnabled": True or False, # Whether point in time recovery is enabled. + "replicationLogArchivingEnabled": True or False, # Reserved for future use. + "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - `HH:MM`. + "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7. + "transactionalLogStorageState": "A String", # Output only. This value contains the storage location of transactional logs for the database for point-in-time recovery. + }, + "collation": "A String", # The name of server Instance collation. + "connectionPoolConfig": { # The managed connection pooling configuration. # Optional. The managed connection pooling configuration for the instance. + "connectionPoolingEnabled": True or False, # Whether managed connection pooling is enabled. + "flags": [ # Optional. List of connection pool configuration flags. + { # Connection pool flags for Cloud SQL instances managed connection pool configuration. + "name": "A String", # Required. The name of the flag. + "value": "A String", # Required. The value of the flag. Boolean flags are set to `on` for true and `off` for false. This field must be omitted if the flag doesn't take a value. + }, + ], + "poolerCount": 42, # Output only. Number of connection poolers. + }, + "connectorEnforcement": "A String", # Specifies if connections must use Cloud SQL connectors. Option values include the following: `NOT_REQUIRED` (Cloud SQL instances can be connected without Cloud SQL Connectors) and `REQUIRED` (Only allow connections that use Cloud SQL Connectors) Note that using REQUIRED disables all existing authorized networks. If this field is not specified when creating a new instance, NOT_REQUIRED is used. If this field is not specified when patching or updating an existing instance, it is left unchanged in the instance. + "crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances. + "dataApiAccess": "A String", # This parameter controls whether to allow using ExecuteSql API to connect to the instance. Not allowed by default. + "dataCacheConfig": { # Data cache configurations. # Configuration for data cache. + "dataCacheEnabled": True or False, # Whether data cache is enabled for the instance. + }, + "dataDiskProvisionedIops": "A String", # Optional. Provisioned number of I/O operations per second for the data disk. This field is only used for hyperdisk-balanced disk types. + "dataDiskProvisionedThroughput": "A String", # Optional. Provisioned throughput measured in MiB per second for the data disk. This field is only used for hyperdisk-balanced disk types. + "dataDiskSizeGb": "A String", # The size of data disk, in GB. The data disk size minimum is 10GB. + "dataDiskType": "A String", # The type of data disk: `PD_SSD` (default) or `PD_HDD`. Not used for First Generation instances. + "databaseFlags": [ # The database flags passed to the instance at startup. + { # Database flags for Cloud SQL instances. + "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both server options and system variables. Flags are specified with underscores, not hyphens. For more information, see [Configuring Database Flags](https://cloud.google.com/sql/docs/mysql/flags) in the Cloud SQL documentation. + "value": "A String", # The value of the flag. Boolean flags are set to `on` for true and `off` for false. This field must be omitted if the flag doesn't take a value. + }, + ], + "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not. WARNING: Changing this restarts the instance. + "deletionProtectionEnabled": True or False, # Configuration to protect against accidental instance deletion. + "denyMaintenancePeriods": [ # Deny maintenance periods + { # Deny Maintenance Periods. This specifies a date range during when all CSA rollout will be denied. + "endDate": "A String", # "deny maintenance period" end date. If the year of the end date is empty, the year of the start date also must be empty. In this case, it means the deny maintenance period recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01 + "startDate": "A String", # "deny maintenance period" start date. If the year of the start date is empty, the year of the end date also must be empty. In this case, it means the deny maintenance period recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01 + "time": "A String", # Time in UTC when the "deny maintenance period" starts on start_date and ends on end_date. The time is in format: HH:mm:SS, i.e., 00:00:00 + }, + ], + "edition": "A String", # Optional. The edition of the instance. + "enableDataplexIntegration": True or False, # Optional. By default, Cloud SQL instances have schema extraction disabled for Dataplex. When this parameter is set to true, schema extraction for Dataplex on Cloud SQL instances is activated. + "enableGoogleMlIntegration": True or False, # Optional. When this parameter is set to true, Cloud SQL instances can connect to Vertex AI to pass requests for real-time predictions and insights to the AI. The default value is false. This applies only to Cloud SQL for MySQL and Cloud SQL for PostgreSQL instances. + "entraidConfig": { # SQL Server Entra ID configuration. # Optional. The Microsoft Entra ID configuration for the SQL Server instance. + "applicationId": "A String", # Optional. The application ID for the Entra ID configuration. + "kind": "A String", # Output only. This is always sql#sqlServerEntraIdConfig + "tenantId": "A String", # Optional. The tenant ID for the Entra ID configuration. + }, + "finalBackupConfig": { # Config used to determine the final backup settings for the instance. # Optional. The final backup configuration for the instance. + "enabled": True or False, # Whether the final backup is enabled for the instance. + "retentionDays": 42, # The number of days to retain the final backup after the instance deletion. The final backup will be purged at (time_of_instance_deletion + retention_days). + }, + "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres. + "enhancedQueryInsightsEnabled": True or False, # Optional. Whether enhanced query insights feature is enabled. + "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled. + "queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. Default is 5. + "queryStringLength": 42, # Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query lengths greater than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database. + "recordApplicationTags": True or False, # Whether Query Insights will record application tags from query when enabled. + "recordClientAddress": True or False, # Whether Query Insights will record client address when enabled. + }, + "ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled for Second Generation instances. + "allocatedIpRange": "A String", # The name of the allocated ip range for the private ip Cloud SQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with [RFC 1035](https://tools.ietf.org/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?.` + "authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: `157.197.200.0/24`). + { # An entry for an Access Control list. + "expirationTime": "A String", # The time when this access control entry expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. + "kind": "A String", # This is always `sql#aclEntry`. + "name": "A String", # Optional. A label to identify this entry. + "value": "A String", # The allowlisted value for the access control list. + }, + ], + "customSubjectAlternativeNames": [ # Optional. Custom Subject Alternative Name(SAN)s for a Cloud SQL instance. + "A String", + ], + "enablePrivatePathForGoogleCloudServices": True or False, # Controls connectivity to private IP instances from Google services, such as BigQuery. + "ipv4Enabled": True or False, # Whether the instance is assigned a public IP address or not. + "privateNetwork": "A String", # The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, `/projects/myProject/global/networks/default`. This setting can be updated, but it cannot be removed after it is set. + "pscConfig": { # PSC settings for a Cloud SQL instance. # PSC settings for this instance. + "allowedConsumerProjects": [ # Optional. The list of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects. Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric). + "A String", + ], + "networkAttachmentUri": "A String", # Optional. The network attachment of the consumer network that the Private Service Connect enabled Cloud SQL instance is authorized to connect via PSC interface. format: projects/PROJECT/regions/REGION/networkAttachments/ID + "pscAutoConnections": [ # Optional. The list of settings for requested Private Service Connect consumer endpoints that can be used to connect to this Cloud SQL instance. + { # Settings for an automatically-setup Private Service Connect consumer endpoint that is used to connect to a Cloud SQL instance. + "consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. + "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. + "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. Optional. This is only applicable if consumer_network is a shared vpc network. + "ipAddress": "A String", # The IP address of the consumer endpoint. + "status": "A String", # The connection status of the consumer endpoint. + }, + ], + "pscEnabled": True or False, # Whether PSC connectivity is enabled for this instance. + }, + "requireSsl": True or False, # Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the legacy `require_ssl` flag. + "serverCaMode": "A String", # Specify what type of CA is used for the server certificate. + "serverCaPool": "A String", # Optional. The resource name of the server CA pool for an instance with `CUSTOMER_MANAGED_CAS_CA` as the `server_ca_mode`. Format: projects/{PROJECT}/locations/{REGION}/caPools/{CA_POOL_ID} + "serverCertificateRotationMode": "A String", # Optional. Controls the automatic server certificate rotation feature. This feature is disabled by default. When enabled, the server certificate will be automatically rotated during Cloud SQL scheduled maintenance or self-service maintenance updates up to six months before it expires. This setting can only be set if server_ca_mode is either GOOGLE_MANAGED_CAS_CA or CUSTOMER_MANAGED_CAS_CA. + "sslMode": "A String", # Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections. + }, + "kind": "A String", # This is always `sql#settings`. + "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance is located. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or Compute Engine zone for better performance. App Engine co-location was only applicable to First Generation instances. + "followGaeApplication": "A String", # The App Engine application to follow, it must be in the same region as the Cloud SQL instance. WARNING: Changing this might restart the instance. + "kind": "A String", # This is always `sql#locationPreference`. + "secondaryZone": "A String", # The preferred Compute Engine zone for the secondary/failover (for example: us-central1-a, us-central1-b, etc.). To disable this field, set it to 'no_secondary_zone'. + "zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.). WARNING: Changing this might restart the instance. + }, + "maintenanceWindow": { # Maintenance window. This specifies when a Cloud SQL instance is restarted for system maintenance purposes. # The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes. + "day": 42, # Day of week - `MONDAY`, `TUESDAY`, `WEDNESDAY`, `THURSDAY`, `FRIDAY`, `SATURDAY`, or `SUNDAY`. Specify in the UTC time zone. Returned in output as an integer, 1 to 7, where `1` equals Monday. + "hour": 42, # Hour of day - 0 to 23. Specify in the UTC time zone. + "kind": "A String", # This is always `sql#maintenanceWindow`. + "updateTrack": "A String", # Maintenance timing settings: `canary`, `stable`, or `week5`. For more information, see [About maintenance on Cloud SQL instances](https://cloud.google.com/sql/docs/mysql/maintenance). + }, + "passwordValidationPolicy": { # Database instance local user password validation policy. This message defines the password policy for local database users. When enabled, it enforces constraints on password complexity, length, and reuse. Keep this policy enabled to help prevent unauthorized access. # The local user password validation policy of the instance. + "complexity": "A String", # The complexity of the password. + "disallowCompromisedCredentials": True or False, # This field is deprecated and will be removed in a future version of the API. + "disallowUsernameSubstring": True or False, # Disallow username as a part of the password. + "enablePasswordPolicy": True or False, # Whether to enable the password policy or not. When enabled, passwords must meet complexity requirements. Keep this policy enabled to help prevent unauthorized access. Disabling this policy allows weak passwords. + "minLength": 42, # Minimum number of characters allowed. + "passwordChangeInterval": "A String", # Minimum interval after which the password can be changed. This flag is only supported for PostgreSQL. + "reuseInterval": 42, # Number of previous passwords that cannot be reused. + }, + "performanceCaptureConfig": { # Performance Capture configuration. # Optional. Configuration for Performance Capture, provides diagnostic metrics during high load situations. + "enabled": True or False, # Optional. Enable or disable the Performance Capture. + "probeThreshold": 42, # Optional. The minimum number of consecutive readings above threshold that triggers instance state capture. + "probingIntervalSeconds": 42, # Optional. The time interval in seconds between any two probes. + "runningThreadsThreshold": 42, # Optional. The minimum number of server threads running to trigger the capture on primary. + "secondsBehindSourceThreshold": 42, # Optional. The minimum number of seconds replica must be lagging behind primary to trigger capture on replica. + "transactionDurationThreshold": 42, # Optional. The amount of time in seconds that a transaction needs to have been open before the watcher starts recording it. + }, + "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances. + "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance. + "disableScaleIn": True or False, # Indicates whether read pool auto scaling supports scale in operations (removing nodes). + "enabled": True or False, # Indicates whether read pool auto scaling is enabled. + "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained. + "minNodeCount": 42, # Minimum number of read pool nodes to be maintained. + "scaleInCooldownSeconds": 42, # The cooldown period for scale in operations. + "scaleOutCooldownSeconds": 42, # The cooldown period for scale out operations. + "targetMetrics": [ # Optional. Target metrics for read pool auto scaling. + { # Target metric for read pool auto scaling. + "metric": "A String", # The metric name to be used for auto scaling. + "targetValue": 3.14, # The target value for the metric. + }, + ], + }, + "replicationLagMaxSeconds": 42, # Optional. Configuration value for recreation of replica after certain replication lag. + "replicationType": "A String", # The type of replication this instance uses. This can be either `ASYNCHRONOUS` or `SYNCHRONOUS`. (Deprecated) This property was only applicable to First Generation instances. + "retainBackupsOnDelete": True or False, # Optional. When this parameter is set to true, Cloud SQL retains backups of the instance even after the instance is deleted. The ON_DEMAND backup will be retained until customer deletes the backup or the project. The AUTOMATED backup will be retained based on the backups retention setting. + "settingsVersion": "A String", # The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value. + "sqlServerAuditConfig": { # SQL Server specific audit configuration. # SQL Server specific audit configuration. + "bucket": "A String", # The name of the destination bucket (e.g., gs://mybucket). + "kind": "A String", # This is always sql#sqlServerAuditConfig + "retentionInterval": "A String", # How long to keep generated audit files. + "uploadInterval": "A String", # How often to upload generated audit files. + }, + "storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is true. + "storageAutoResizeLimit": "A String", # The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit. + "tier": "A String", # The tier (or machine type) for this instance, for example `db-custom-1-3840`. WARNING: Changing this restarts the instance. + "timeZone": "A String", # Server timezone, relevant only for Cloud SQL for SQL Server. + "userLabels": { # User-provided labels, represented as a dictionary where each label is a single key value pair. + "a_key": "A String", + }, + }, + "sqlNetworkArchitecture": "A String", # The SQL network architecture for the instance. + "state": "A String", # The current serving state of the Cloud SQL instance. + "suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. + "A String", + ], + "switchTransactionLogsToCloudStorageEnabled": True or False, # Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage. + "tags": { # Optional. Input only. Immutable. Tag keys and tag values that are bound to this instance. You must represent each item in the map as: `"" : ""`. For example, a single resource can have the following tags: ``` "123/environment": "production", "123/costCenter": "marketing", ``` For more information on tag creation and management, see https://cloud.google.com/resource-manager/docs/tags/tags-overview. + "a_key": "A String", + }, + "upgradableDatabaseVersions": [ # Output only. All database versions that are available for upgrade. + { # An available database version. It can be a major or a minor version. + "displayName": "A String", # The database version's display name. + "majorVersion": "A String", # The version's major version name. + "name": "A String", # The database version name. For MySQL 8.0, this string provides the database major and minor version. + }, + ], + "writeEndpoint": "A String", # Output only. The dns name of the primary instance in a replication group. + }, } x__xgafv: string, V1 error format. diff --git a/googleapiclient/discovery_cache/documents/sqladmin.v1.json b/googleapiclient/discovery_cache/documents/sqladmin.v1.json index 18b1b8a86c..390a9c0485 100644 --- a/googleapiclient/discovery_cache/documents/sqladmin.v1.json +++ b/googleapiclient/discovery_cache/documents/sqladmin.v1.json @@ -2795,7 +2795,7 @@ } } }, -"revision": "20260222", +"revision": "20260303", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -7040,9 +7040,24 @@ false "description": "Optional. The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, `/projects/myProject/global/networks/default`.", "type": "string" }, +"region": { +"description": "Optional. The region of the target instance where the datasource will be restored. For example: \"us-central1\".", +"type": "string" +}, "targetInstance": { "description": "Target instance name.", "type": "string" +}, +"targetInstanceClearSettingsFieldNames": { +"description": "Optional. Specifies the instance settings that will be cleared from the source instance. This field is only applicable for cross project PITRs.", +"items": { +"type": "string" +}, +"type": "array" +}, +"targetInstanceSettings": { +"$ref": "DatabaseInstance", +"description": "Optional. Specifies the instance settings that will be overridden from the source instance. This field is only applicable for cross project PITRs." } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json b/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json index 3c060d92fe..fd58329258 100644 --- a/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json +++ b/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json @@ -2795,7 +2795,7 @@ } } }, -"revision": "20260222", +"revision": "20260303", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -7041,9 +7041,24 @@ false "description": "Optional. The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, `/projects/myProject/global/networks/default`.", "type": "string" }, +"region": { +"description": "Optional. The region of the target instance where the datasource will be restored. For example: \"us-central1\".", +"type": "string" +}, "targetInstance": { "description": "Target instance name.", "type": "string" +}, +"targetInstanceClearSettingsFieldNames": { +"description": "Optional. Specifies the instance settings that will be cleared from the source instance. This field is only applicable for cross project PITRs.", +"items": { +"type": "string" +}, +"type": "array" +}, +"targetInstanceSettings": { +"$ref": "DatabaseInstance", +"description": "Optional. Specifies the instance settings that will be overridden from the source instance. This field is only applicable for cross project PITRs." } }, "type": "object" From 3f28d69758014fca8d511f45e0d3d4cc20c42cd4 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 10 Mar 2026 07:24:07 +0000 Subject: [PATCH 28/31] feat(tagmanager): update the api #### tagmanager:v2 The following keys were added: - schemas.VariableFormatValue.properties.convertToBoolean.type (Total Keys: 1) - schemas.VariableFormatValue.properties.convertToNumber.type (Total Keys: 1) --- ...nager_v2.accounts.containers.versions.html | 14 +++++++++++++ ...ccounts.containers.workspaces.folders.html | 2 ++ ...ger_v2.accounts.containers.workspaces.html | 20 +++++++++++++++++++ ...ounts.containers.workspaces.variables.html | 14 +++++++++++++ .../documents/tagmanager.v2.json | 20 ++++++++++++++++++- 5 files changed, 69 insertions(+), 1 deletion(-) diff --git a/docs/dyn/tagmanager_v2.accounts.containers.versions.html b/docs/dyn/tagmanager_v2.accounts.containers.versions.html index fe5d3edd02..de77b906a9 100644 --- a/docs/dyn/tagmanager_v2.accounts.containers.versions.html +++ b/docs/dyn/tagmanager_v2.accounts.containers.versions.html @@ -730,6 +730,8 @@

Method Details

"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name "value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type. }, + "convertToBoolean": True or False, # The option to convert a variable value to a boolean. + "convertToNumber": "A String", # The option to convert a variable value to a number. "convertTrueToValue": { # Represents a Google Tag Manager Parameter. # The value to convert if a variable value is true. "isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. @@ -1445,6 +1447,8 @@

Method Details

"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name "value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type. }, + "convertToBoolean": True or False, # The option to convert a variable value to a boolean. + "convertToNumber": "A String", # The option to convert a variable value to a number. "convertTrueToValue": { # Represents a Google Tag Manager Parameter. # The value to convert if a variable value is true. "isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. @@ -2163,6 +2167,8 @@

Method Details

"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name "value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type. }, + "convertToBoolean": True or False, # The option to convert a variable value to a boolean. + "convertToNumber": "A String", # The option to convert a variable value to a number. "convertTrueToValue": { # Represents a Google Tag Manager Parameter. # The value to convert if a variable value is true. "isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. @@ -2879,6 +2885,8 @@

Method Details

"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name "value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type. }, + "convertToBoolean": True or False, # The option to convert a variable value to a boolean. + "convertToNumber": "A String", # The option to convert a variable value to a number. "convertTrueToValue": { # Represents a Google Tag Manager Parameter. # The value to convert if a variable value is true. "isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. @@ -3594,6 +3602,8 @@

Method Details

"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name "value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type. }, + "convertToBoolean": True or False, # The option to convert a variable value to a boolean. + "convertToNumber": "A String", # The option to convert a variable value to a number. "convertTrueToValue": { # Represents a Google Tag Manager Parameter. # The value to convert if a variable value is true. "isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. @@ -4304,6 +4314,8 @@

Method Details

"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name "value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type. }, + "convertToBoolean": True or False, # The option to convert a variable value to a boolean. + "convertToNumber": "A String", # The option to convert a variable value to a number. "convertTrueToValue": { # Represents a Google Tag Manager Parameter. # The value to convert if a variable value is true. "isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. @@ -5013,6 +5025,8 @@

Method Details

"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name "value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type. }, + "convertToBoolean": True or False, # The option to convert a variable value to a boolean. + "convertToNumber": "A String", # The option to convert a variable value to a number. "convertTrueToValue": { # Represents a Google Tag Manager Parameter. # The value to convert if a variable value is true. "isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. diff --git a/docs/dyn/tagmanager_v2.accounts.containers.workspaces.folders.html b/docs/dyn/tagmanager_v2.accounts.containers.workspaces.folders.html index ce147d8983..9cfff5fdcc 100644 --- a/docs/dyn/tagmanager_v2.accounts.containers.workspaces.folders.html +++ b/docs/dyn/tagmanager_v2.accounts.containers.workspaces.folders.html @@ -604,6 +604,8 @@

Method Details

"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name "value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type. }, + "convertToBoolean": True or False, # The option to convert a variable value to a boolean. + "convertToNumber": "A String", # The option to convert a variable value to a number. "convertTrueToValue": { # Represents a Google Tag Manager Parameter. # The value to convert if a variable value is true. "isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. diff --git a/docs/dyn/tagmanager_v2.accounts.containers.workspaces.html b/docs/dyn/tagmanager_v2.accounts.containers.workspaces.html index 9f4ca7062c..a6017f140e 100644 --- a/docs/dyn/tagmanager_v2.accounts.containers.workspaces.html +++ b/docs/dyn/tagmanager_v2.accounts.containers.workspaces.html @@ -710,6 +710,8 @@

Method Details

"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name "value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type. }, + "convertToBoolean": True or False, # The option to convert a variable value to a boolean. + "convertToNumber": "A String", # The option to convert a variable value to a number. "convertTrueToValue": { # Represents a Google Tag Manager Parameter. # The value to convert if a variable value is true. "isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. @@ -1356,6 +1358,8 @@

Method Details

"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name "value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type. }, + "convertToBoolean": True or False, # The option to convert a variable value to a boolean. + "convertToNumber": "A String", # The option to convert a variable value to a number. "convertTrueToValue": { # Represents a Google Tag Manager Parameter. # The value to convert if a variable value is true. "isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. @@ -2125,6 +2129,8 @@

Method Details

"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name "value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type. }, + "convertToBoolean": True or False, # The option to convert a variable value to a boolean. + "convertToNumber": "A String", # The option to convert a variable value to a number. "convertTrueToValue": { # Represents a Google Tag Manager Parameter. # The value to convert if a variable value is true. "isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. @@ -2825,6 +2831,8 @@

Method Details

"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name "value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type. }, + "convertToBoolean": True or False, # The option to convert a variable value to a boolean. + "convertToNumber": "A String", # The option to convert a variable value to a number. "convertTrueToValue": { # Represents a Google Tag Manager Parameter. # The value to convert if a variable value is true. "isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. @@ -3458,6 +3466,8 @@

Method Details

"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name "value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type. }, + "convertToBoolean": True or False, # The option to convert a variable value to a boolean. + "convertToNumber": "A String", # The option to convert a variable value to a number. "convertTrueToValue": { # Represents a Google Tag Manager Parameter. # The value to convert if a variable value is true. "isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. @@ -4094,6 +4104,8 @@

Method Details

"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name "value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type. }, + "convertToBoolean": True or False, # The option to convert a variable value to a boolean. + "convertToNumber": "A String", # The option to convert a variable value to a number. "convertTrueToValue": { # Represents a Google Tag Manager Parameter. # The value to convert if a variable value is true. "isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. @@ -4856,6 +4868,8 @@

Method Details

"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name "value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type. }, + "convertToBoolean": True or False, # The option to convert a variable value to a boolean. + "convertToNumber": "A String", # The option to convert a variable value to a number. "convertTrueToValue": { # Represents a Google Tag Manager Parameter. # The value to convert if a variable value is true. "isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. @@ -5508,6 +5522,8 @@

Method Details

"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name "value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type. }, + "convertToBoolean": True or False, # The option to convert a variable value to a boolean. + "convertToNumber": "A String", # The option to convert a variable value to a number. "convertTrueToValue": { # Represents a Google Tag Manager Parameter. # The value to convert if a variable value is true. "isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. @@ -6167,6 +6183,8 @@

Method Details

"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name "value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type. }, + "convertToBoolean": True or False, # The option to convert a variable value to a boolean. + "convertToNumber": "A String", # The option to convert a variable value to a number. "convertTrueToValue": { # Represents a Google Tag Manager Parameter. # The value to convert if a variable value is true. "isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. @@ -6800,6 +6818,8 @@

Method Details

"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name "value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type. }, + "convertToBoolean": True or False, # The option to convert a variable value to a boolean. + "convertToNumber": "A String", # The option to convert a variable value to a number. "convertTrueToValue": { # Represents a Google Tag Manager Parameter. # The value to convert if a variable value is true. "isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. diff --git a/docs/dyn/tagmanager_v2.accounts.containers.workspaces.variables.html b/docs/dyn/tagmanager_v2.accounts.containers.workspaces.variables.html index aa60b91291..1a30874023 100644 --- a/docs/dyn/tagmanager_v2.accounts.containers.workspaces.variables.html +++ b/docs/dyn/tagmanager_v2.accounts.containers.workspaces.variables.html @@ -149,6 +149,8 @@

Method Details

"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name "value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type. }, + "convertToBoolean": True or False, # The option to convert a variable value to a boolean. + "convertToNumber": "A String", # The option to convert a variable value to a number. "convertTrueToValue": { # Represents a Google Tag Manager Parameter. # The value to convert if a variable value is true. "isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. @@ -244,6 +246,8 @@

Method Details

"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name "value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type. }, + "convertToBoolean": True or False, # The option to convert a variable value to a boolean. + "convertToNumber": "A String", # The option to convert a variable value to a number. "convertTrueToValue": { # Represents a Google Tag Manager Parameter. # The value to convert if a variable value is true. "isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. @@ -359,6 +363,8 @@

Method Details

"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name "value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type. }, + "convertToBoolean": True or False, # The option to convert a variable value to a boolean. + "convertToNumber": "A String", # The option to convert a variable value to a number. "convertTrueToValue": { # Represents a Google Tag Manager Parameter. # The value to convert if a variable value is true. "isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. @@ -465,6 +471,8 @@

Method Details

"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name "value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type. }, + "convertToBoolean": True or False, # The option to convert a variable value to a boolean. + "convertToNumber": "A String", # The option to convert a variable value to a number. "convertTrueToValue": { # Represents a Google Tag Manager Parameter. # The value to convert if a variable value is true. "isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. @@ -585,6 +593,8 @@

Method Details

"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name "value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type. }, + "convertToBoolean": True or False, # The option to convert a variable value to a boolean. + "convertToNumber": "A String", # The option to convert a variable value to a number. "convertTrueToValue": { # Represents a Google Tag Manager Parameter. # The value to convert if a variable value is true. "isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. @@ -683,6 +693,8 @@

Method Details

"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name "value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type. }, + "convertToBoolean": True or False, # The option to convert a variable value to a boolean. + "convertToNumber": "A String", # The option to convert a variable value to a number. "convertTrueToValue": { # Represents a Google Tag Manager Parameter. # The value to convert if a variable value is true. "isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. @@ -779,6 +791,8 @@

Method Details

"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name "value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type. }, + "convertToBoolean": True or False, # The option to convert a variable value to a boolean. + "convertToNumber": "A String", # The option to convert a variable value to a number. "convertTrueToValue": { # Represents a Google Tag Manager Parameter. # The value to convert if a variable value is true. "isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. diff --git a/googleapiclient/discovery_cache/documents/tagmanager.v2.json b/googleapiclient/discovery_cache/documents/tagmanager.v2.json index 8483c2235f..7383ef3b1e 100644 --- a/googleapiclient/discovery_cache/documents/tagmanager.v2.json +++ b/googleapiclient/discovery_cache/documents/tagmanager.v2.json @@ -3986,7 +3986,7 @@ } } }, -"revision": "20251203", +"revision": "20260304", "rootUrl": "https://tagmanager.googleapis.com/", "schemas": { "Account": { @@ -6453,6 +6453,24 @@ "$ref": "Parameter", "description": "The value to convert if a variable value is null." }, +"convertToBoolean": { +"description": "The option to convert a variable value to a boolean.", +"type": "boolean" +}, +"convertToNumber": { +"description": "The option to convert a variable value to a number.", +"enum": [ +"decimalSeparatorTypeUnspecified", +"period", +"comma" +], +"enumDescriptions": [ +"", +"The option to convert a variable value to a number with a period as the decimal separator.", +"The option to convert a variable value to a number with a comma as the decimal separator." +], +"type": "string" +}, "convertTrueToValue": { "$ref": "Parameter", "description": "The value to convert if a variable value is true." From ac00e5cae0d588a1d962e3b876d73b7c0a42b860 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 10 Mar 2026 07:24:07 +0000 Subject: [PATCH 29/31] feat(travelimpactmodel): update the api #### travelimpactmodel:v1 The following keys were deleted: - schemas.McpToolDataHandlingProfile (Total Keys: 4) - schemas.McpToolLifecycleProfile (Total Keys: 4) --- .../documents/travelimpactmodel.v1.json | 77 +------------------ 1 file changed, 1 insertion(+), 76 deletions(-) diff --git a/googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json b/googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json index 052b6f8b35..9403a963b9 100644 --- a/googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json +++ b/googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json @@ -146,7 +146,7 @@ } } }, -"revision": "20260127", +"revision": "20260308", "rootUrl": "https://travelimpactmodel.googleapis.com/", "schemas": { "ComputeFlightEmissionsRequest": { @@ -414,81 +414,6 @@ }, "type": "object" }, -"McpToolDataHandlingProfile": { -"description": "Profile describing the data handling characteristics of an MCP tool. When used within the McpTool.meta field, this message should be packed into a google.protobuf.Any and associated with the key: \"google.com/tool.profiles/data_handling\"", -"id": "McpToolDataHandlingProfile", -"properties": { -"inputDataAccessLevel": { -"description": "// The data access level of the tool's inputs.", -"enum": [ -"DATA_ACCESS_LEVEL_UNSPECIFIED", -"DATA_ACCESS_LEVEL_PUBLIC", -"DATA_ACCESS_LEVEL_CONFIDENTIAL", -"DATA_ACCESS_LEVEL_NEED_TO_KNOW", -"DATA_ACCESS_LEVEL_PII", -"DATA_ACCESS_LEVEL_USER", -"DATA_ACCESS_LEVEL_NO_DATA_ACCESS" -], -"enumDescriptions": [ -"The default value. This value is unused.", -"Public data.", -"Confidential data.", -"Need-to-know data.", -"Personally Identifiable Information (PII) data.", -"User data.", -"The tool does not access any data." -], -"type": "string" -}, -"outputDataAccessLevel": { -"description": "The data access level of the tool's outputs.", -"enum": [ -"DATA_ACCESS_LEVEL_UNSPECIFIED", -"DATA_ACCESS_LEVEL_PUBLIC", -"DATA_ACCESS_LEVEL_CONFIDENTIAL", -"DATA_ACCESS_LEVEL_NEED_TO_KNOW", -"DATA_ACCESS_LEVEL_PII", -"DATA_ACCESS_LEVEL_USER", -"DATA_ACCESS_LEVEL_NO_DATA_ACCESS" -], -"enumDescriptions": [ -"The default value. This value is unused.", -"Public data.", -"Confidential data.", -"Need-to-know data.", -"Personally Identifiable Information (PII) data.", -"User data.", -"The tool does not access any data." -], -"type": "string" -} -}, -"type": "object" -}, -"McpToolLifecycleProfile": { -"description": "Profile describing the lifecycle stage of an MCP tool. When used within the McpTool.meta field, this message should be packed into a google.protobuf.Any and associated with the key: \"google.com/tool.profiles/lifecycle\"", -"id": "McpToolLifecycleProfile", -"properties": { -"launchState": { -"description": "Output only. The current launch state of the MCP tool.", -"enum": [ -"LAUNCH_STATE_UNSPECIFIED", -"LAUNCH_STATE_DEVELOPMENT", -"LAUNCH_STATE_PRODUCTION_PREVIEW", -"LAUNCH_STATE_GENERAL_AVAILABILITY" -], -"enumDescriptions": [ -"The default value. This value is unused.", -"The tool is currently in development.", -"The tool is in production preview.", -"The tool is generally available." -], -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, "ModelVersion": { "description": "Travel Impact Model version. For more information about the model versioning see [GitHub](https://github.com/google/travel-impact-model/#versioning).", "id": "ModelVersion", From d0ab934515dbb564a590f88467def6382cec247b Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 10 Mar 2026 07:24:07 +0000 Subject: [PATCH 30/31] feat(videointelligence): update the api #### videointelligence:v1 The following keys were added: - resources.projects.resources.locations.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - schemas.GoogleCloudVideointelligenceV1_SpeechTranscriptionConfig.properties.audioOutputUriPrefix.type (Total Keys: 1) - schemas.GoogleCloudVideointelligenceV1_WordInfo.properties.speakerLabel (Total Keys: 2) - schemas.GoogleCloudVideointelligenceV1beta2_WordInfo.properties.speakerLabel (Total Keys: 2) - schemas.GoogleCloudVideointelligenceV1p1beta1_WordInfo.properties.speakerLabel (Total Keys: 2) - schemas.GoogleCloudVideointelligenceV1p2beta1_WordInfo.properties.speakerLabel (Total Keys: 2) - schemas.GoogleCloudVideointelligenceV1p3beta1_WordInfo.properties.speakerLabel (Total Keys: 2) - schemas.GoogleLongrunning_ListOperationsResponse.properties.unreachable (Total Keys: 2) #### videointelligence:v1beta2 The following keys were added: - schemas.GoogleCloudVideointelligenceV1_WordInfo.properties.speakerLabel (Total Keys: 2) - schemas.GoogleCloudVideointelligenceV1beta2_SpeechTranscriptionConfig.properties.audioOutputUriPrefix.type (Total Keys: 1) - schemas.GoogleCloudVideointelligenceV1beta2_WordInfo.properties.speakerLabel (Total Keys: 2) - schemas.GoogleCloudVideointelligenceV1p1beta1_WordInfo.properties.speakerLabel (Total Keys: 2) - schemas.GoogleCloudVideointelligenceV1p2beta1_WordInfo.properties.speakerLabel (Total Keys: 2) - schemas.GoogleCloudVideointelligenceV1p3beta1_WordInfo.properties.speakerLabel (Total Keys: 2) #### videointelligence:v1p1beta1 The following keys were added: - schemas.GoogleCloudVideointelligenceV1_WordInfo.properties.speakerLabel (Total Keys: 2) - schemas.GoogleCloudVideointelligenceV1beta2_WordInfo.properties.speakerLabel (Total Keys: 2) - schemas.GoogleCloudVideointelligenceV1p1beta1_SpeechTranscriptionConfig.properties.audioOutputUriPrefix.type (Total Keys: 1) - schemas.GoogleCloudVideointelligenceV1p1beta1_WordInfo.properties.speakerLabel (Total Keys: 2) - schemas.GoogleCloudVideointelligenceV1p2beta1_WordInfo.properties.speakerLabel (Total Keys: 2) - schemas.GoogleCloudVideointelligenceV1p3beta1_WordInfo.properties.speakerLabel (Total Keys: 2) #### videointelligence:v1p2beta1 The following keys were added: - schemas.GoogleCloudVideointelligenceV1_WordInfo.properties.speakerLabel (Total Keys: 2) - schemas.GoogleCloudVideointelligenceV1beta2_WordInfo.properties.speakerLabel (Total Keys: 2) - schemas.GoogleCloudVideointelligenceV1p1beta1_WordInfo.properties.speakerLabel (Total Keys: 2) - schemas.GoogleCloudVideointelligenceV1p2beta1_SpeechTranscriptionConfig.properties.audioOutputUriPrefix.type (Total Keys: 1) - schemas.GoogleCloudVideointelligenceV1p2beta1_WordInfo.properties.speakerLabel (Total Keys: 2) - schemas.GoogleCloudVideointelligenceV1p3beta1_WordInfo.properties.speakerLabel (Total Keys: 2) #### videointelligence:v1p3beta1 The following keys were added: - schemas.GoogleCloudVideointelligenceV1_WordInfo.properties.speakerLabel (Total Keys: 2) - schemas.GoogleCloudVideointelligenceV1beta2_WordInfo.properties.speakerLabel (Total Keys: 2) - schemas.GoogleCloudVideointelligenceV1p1beta1_WordInfo.properties.speakerLabel (Total Keys: 2) - schemas.GoogleCloudVideointelligenceV1p2beta1_WordInfo.properties.speakerLabel (Total Keys: 2) - schemas.GoogleCloudVideointelligenceV1p3beta1_SpeechTranscriptionConfig.properties.audioOutputUriPrefix.type (Total Keys: 1) - schemas.GoogleCloudVideointelligenceV1p3beta1_WordInfo.properties.speakerLabel (Total Keys: 2) --- ...ence_v1.projects.locations.operations.html | 8 +++- docs/dyn/videointelligence_v1.videos.html | 1 + .../dyn/videointelligence_v1beta2.videos.html | 1 + .../videointelligence_v1p1beta1.videos.html | 1 + .../videointelligence_v1p2beta1.videos.html | 1 + .../videointelligence_v1p3beta1.videos.html | 1 + .../documents/videointelligence.v1.json | 43 ++++++++++++++++++- .../documents/videointelligence.v1beta2.json | 31 ++++++++++++- .../videointelligence.v1p1beta1.json | 31 ++++++++++++- .../videointelligence.v1p2beta1.json | 31 ++++++++++++- .../videointelligence.v1p3beta1.json | 31 ++++++++++++- 11 files changed, 173 insertions(+), 7 deletions(-) diff --git a/docs/dyn/videointelligence_v1.projects.locations.operations.html b/docs/dyn/videointelligence_v1.projects.locations.operations.html index 963dab7e73..b40d9b6497 100644 --- a/docs/dyn/videointelligence_v1.projects.locations.operations.html +++ b/docs/dyn/videointelligence_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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,6 +216,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/videointelligence_v1.videos.html b/docs/dyn/videointelligence_v1.videos.html index eb3826ced3..f8cbabfe49 100644 --- a/docs/dyn/videointelligence_v1.videos.html +++ b/docs/dyn/videointelligence_v1.videos.html @@ -131,6 +131,7 @@

Method Details

"model": "A String", # Model to use for shot change detection. Supported values: "builtin/stable" (the default if unset), "builtin/latest", and "builtin/legacy". }, "speechTranscriptionConfig": { # Config for SPEECH_TRANSCRIPTION. # Config for SPEECH_TRANSCRIPTION. + "audioOutputUriPrefix": "A String", # Optional. Legacy field. This field must be a Cloud Storage URI prefix. (e.g., `gs://bucket/path/`). "audioTracks": [ # Optional. For file formats, such as MXF or MKV, supporting multiple audio tracks, specify up to two tracks. Default: track 0. 42, ], diff --git a/docs/dyn/videointelligence_v1beta2.videos.html b/docs/dyn/videointelligence_v1beta2.videos.html index 501f6e5b2e..e66060c6f1 100644 --- a/docs/dyn/videointelligence_v1beta2.videos.html +++ b/docs/dyn/videointelligence_v1beta2.videos.html @@ -131,6 +131,7 @@

Method Details

"model": "A String", # Model to use for shot change detection. Supported values: "builtin/stable" (the default if unset), "builtin/latest", and "builtin/legacy". }, "speechTranscriptionConfig": { # Config for SPEECH_TRANSCRIPTION. # Config for SPEECH_TRANSCRIPTION. + "audioOutputUriPrefix": "A String", # Optional. Legacy field. This field must be a Cloud Storage URI prefix. (e.g., `gs://bucket/path/`). "audioTracks": [ # Optional. For file formats, such as MXF or MKV, supporting multiple audio tracks, specify up to two tracks. Default: track 0. 42, ], diff --git a/docs/dyn/videointelligence_v1p1beta1.videos.html b/docs/dyn/videointelligence_v1p1beta1.videos.html index 7d2752fd72..dfd9767989 100644 --- a/docs/dyn/videointelligence_v1p1beta1.videos.html +++ b/docs/dyn/videointelligence_v1p1beta1.videos.html @@ -131,6 +131,7 @@

Method Details

"model": "A String", # Model to use for shot change detection. Supported values: "builtin/stable" (the default if unset), "builtin/latest", and "builtin/legacy". }, "speechTranscriptionConfig": { # Config for SPEECH_TRANSCRIPTION. # Config for SPEECH_TRANSCRIPTION. + "audioOutputUriPrefix": "A String", # Optional. Legacy field. This field must be a Cloud Storage URI prefix. (e.g., `gs://bucket/path/`). "audioTracks": [ # Optional. For file formats, such as MXF or MKV, supporting multiple audio tracks, specify up to two tracks. Default: track 0. 42, ], diff --git a/docs/dyn/videointelligence_v1p2beta1.videos.html b/docs/dyn/videointelligence_v1p2beta1.videos.html index 4557ea8ed4..093449d62e 100644 --- a/docs/dyn/videointelligence_v1p2beta1.videos.html +++ b/docs/dyn/videointelligence_v1p2beta1.videos.html @@ -131,6 +131,7 @@

Method Details

"model": "A String", # Model to use for shot change detection. Supported values: "builtin/stable" (the default if unset), "builtin/latest", and "builtin/legacy". }, "speechTranscriptionConfig": { # Config for SPEECH_TRANSCRIPTION. # Config for SPEECH_TRANSCRIPTION. + "audioOutputUriPrefix": "A String", # Optional. Legacy field. This field must be a Cloud Storage URI prefix. (e.g., `gs://bucket/path/`). "audioTracks": [ # Optional. For file formats, such as MXF or MKV, supporting multiple audio tracks, specify up to two tracks. Default: track 0. 42, ], diff --git a/docs/dyn/videointelligence_v1p3beta1.videos.html b/docs/dyn/videointelligence_v1p3beta1.videos.html index d363575229..e74fdc2400 100644 --- a/docs/dyn/videointelligence_v1p3beta1.videos.html +++ b/docs/dyn/videointelligence_v1p3beta1.videos.html @@ -131,6 +131,7 @@

Method Details

"model": "A String", # Model to use for shot change detection. Supported values: "builtin/stable" (the default if unset), "builtin/latest", and "builtin/legacy". }, "speechTranscriptionConfig": { # Config for SPEECH_TRANSCRIPTION. # Config for SPEECH_TRANSCRIPTION. + "audioOutputUriPrefix": "A String", # Optional. Legacy field. This field must be a Cloud Storage URI prefix. (e.g., `gs://bucket/path/`). "audioTracks": [ # Optional. For file formats, such as MXF or MKV, supporting multiple audio tracks, specify up to two tracks. Default: track 0. 42, ], diff --git a/googleapiclient/discovery_cache/documents/videointelligence.v1.json b/googleapiclient/discovery_cache/documents/videointelligence.v1.json index a17318846e..86bfc596f1 100644 --- a/googleapiclient/discovery_cache/documents/videointelligence.v1.json +++ b/googleapiclient/discovery_cache/documents/videointelligence.v1.json @@ -311,6 +311,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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -350,7 +355,7 @@ } } }, -"revision": "20250724", +"revision": "20260304", "rootUrl": "https://videointelligence.googleapis.com/", "schemas": { "GoogleCloudVideointelligenceV1_AnnotateVideoProgress": { @@ -1053,6 +1058,10 @@ "description": "Config for SPEECH_TRANSCRIPTION.", "id": "GoogleCloudVideointelligenceV1_SpeechTranscriptionConfig", "properties": { +"audioOutputUriPrefix": { +"description": "Optional. Legacy field. This field must be a Cloud Storage URI prefix. (e.g., `gs://bucket/path/`).", +"type": "string" +}, "audioTracks": { "description": "Optional. For file formats, such as MXF or MKV, supporting multiple audio tracks, specify up to two tracks. Default: track 0.", "items": { @@ -1495,6 +1504,11 @@ "format": "google-duration", "type": "string" }, +"speakerLabel": { +"description": "Output only. A distinct string value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word.", +"readOnly": true, +"type": "string" +}, "speakerTag": { "description": "Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled.", "format": "int32", @@ -2354,6 +2368,11 @@ "format": "google-duration", "type": "string" }, +"speakerLabel": { +"description": "Output only. A distinct string value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word.", +"readOnly": true, +"type": "string" +}, "speakerTag": { "description": "Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled.", "format": "int32", @@ -3213,6 +3232,11 @@ "format": "google-duration", "type": "string" }, +"speakerLabel": { +"description": "Output only. A distinct string value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word.", +"readOnly": true, +"type": "string" +}, "speakerTag": { "description": "Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled.", "format": "int32", @@ -4072,6 +4096,11 @@ "format": "google-duration", "type": "string" }, +"speakerLabel": { +"description": "Output only. A distinct string value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word.", +"readOnly": true, +"type": "string" +}, "speakerTag": { "description": "Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled.", "format": "int32", @@ -5064,6 +5093,11 @@ "format": "google-duration", "type": "string" }, +"speakerLabel": { +"description": "Output only. A distinct string value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word.", +"readOnly": true, +"type": "string" +}, "speakerTag": { "description": "Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled.", "format": "int32", @@ -5102,6 +5136,13 @@ "$ref": "GoogleLongrunning_Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/videointelligence.v1beta2.json b/googleapiclient/discovery_cache/documents/videointelligence.v1beta2.json index 32a856609a..e80e223938 100644 --- a/googleapiclient/discovery_cache/documents/videointelligence.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/videointelligence.v1beta2.json @@ -128,7 +128,7 @@ } } }, -"revision": "20250724", +"revision": "20260304", "rootUrl": "https://videointelligence.googleapis.com/", "schemas": { "GoogleCloudVideointelligenceV1_AnnotateVideoProgress": { @@ -972,6 +972,11 @@ "format": "google-duration", "type": "string" }, +"speakerLabel": { +"description": "Output only. A distinct string value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word.", +"readOnly": true, +"type": "string" +}, "speakerTag": { "description": "Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled.", "format": "int32", @@ -1690,6 +1695,10 @@ "description": "Config for SPEECH_TRANSCRIPTION.", "id": "GoogleCloudVideointelligenceV1beta2_SpeechTranscriptionConfig", "properties": { +"audioOutputUriPrefix": { +"description": "Optional. Legacy field. This field must be a Cloud Storage URI prefix. (e.g., `gs://bucket/path/`).", +"type": "string" +}, "audioTracks": { "description": "Optional. For file formats, such as MXF or MKV, supporting multiple audio tracks, specify up to two tracks. Default: track 0.", "items": { @@ -2132,6 +2141,11 @@ "format": "google-duration", "type": "string" }, +"speakerLabel": { +"description": "Output only. A distinct string value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word.", +"readOnly": true, +"type": "string" +}, "speakerTag": { "description": "Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled.", "format": "int32", @@ -2991,6 +3005,11 @@ "format": "google-duration", "type": "string" }, +"speakerLabel": { +"description": "Output only. A distinct string value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word.", +"readOnly": true, +"type": "string" +}, "speakerTag": { "description": "Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled.", "format": "int32", @@ -3850,6 +3869,11 @@ "format": "google-duration", "type": "string" }, +"speakerLabel": { +"description": "Output only. A distinct string value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word.", +"readOnly": true, +"type": "string" +}, "speakerTag": { "description": "Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled.", "format": "int32", @@ -4842,6 +4866,11 @@ "format": "google-duration", "type": "string" }, +"speakerLabel": { +"description": "Output only. A distinct string value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word.", +"readOnly": true, +"type": "string" +}, "speakerTag": { "description": "Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled.", "format": "int32", diff --git a/googleapiclient/discovery_cache/documents/videointelligence.v1p1beta1.json b/googleapiclient/discovery_cache/documents/videointelligence.v1p1beta1.json index 502afdb2ee..24fe2b345c 100644 --- a/googleapiclient/discovery_cache/documents/videointelligence.v1p1beta1.json +++ b/googleapiclient/discovery_cache/documents/videointelligence.v1p1beta1.json @@ -128,7 +128,7 @@ } } }, -"revision": "20250724", +"revision": "20260304", "rootUrl": "https://videointelligence.googleapis.com/", "schemas": { "GoogleCloudVideointelligenceV1_AnnotateVideoProgress": { @@ -972,6 +972,11 @@ "format": "google-duration", "type": "string" }, +"speakerLabel": { +"description": "Output only. A distinct string value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word.", +"readOnly": true, +"type": "string" +}, "speakerTag": { "description": "Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled.", "format": "int32", @@ -1831,6 +1836,11 @@ "format": "google-duration", "type": "string" }, +"speakerLabel": { +"description": "Output only. A distinct string value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word.", +"readOnly": true, +"type": "string" +}, "speakerTag": { "description": "Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled.", "format": "int32", @@ -2549,6 +2559,10 @@ "description": "Config for SPEECH_TRANSCRIPTION.", "id": "GoogleCloudVideointelligenceV1p1beta1_SpeechTranscriptionConfig", "properties": { +"audioOutputUriPrefix": { +"description": "Optional. Legacy field. This field must be a Cloud Storage URI prefix. (e.g., `gs://bucket/path/`).", +"type": "string" +}, "audioTracks": { "description": "Optional. For file formats, such as MXF or MKV, supporting multiple audio tracks, specify up to two tracks. Default: track 0.", "items": { @@ -2991,6 +3005,11 @@ "format": "google-duration", "type": "string" }, +"speakerLabel": { +"description": "Output only. A distinct string value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word.", +"readOnly": true, +"type": "string" +}, "speakerTag": { "description": "Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled.", "format": "int32", @@ -3850,6 +3869,11 @@ "format": "google-duration", "type": "string" }, +"speakerLabel": { +"description": "Output only. A distinct string value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word.", +"readOnly": true, +"type": "string" +}, "speakerTag": { "description": "Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled.", "format": "int32", @@ -4842,6 +4866,11 @@ "format": "google-duration", "type": "string" }, +"speakerLabel": { +"description": "Output only. A distinct string value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word.", +"readOnly": true, +"type": "string" +}, "speakerTag": { "description": "Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled.", "format": "int32", diff --git a/googleapiclient/discovery_cache/documents/videointelligence.v1p2beta1.json b/googleapiclient/discovery_cache/documents/videointelligence.v1p2beta1.json index 13a94800b0..598be16ad8 100644 --- a/googleapiclient/discovery_cache/documents/videointelligence.v1p2beta1.json +++ b/googleapiclient/discovery_cache/documents/videointelligence.v1p2beta1.json @@ -128,7 +128,7 @@ } } }, -"revision": "20250724", +"revision": "20260304", "rootUrl": "https://videointelligence.googleapis.com/", "schemas": { "GoogleCloudVideointelligenceV1_AnnotateVideoProgress": { @@ -972,6 +972,11 @@ "format": "google-duration", "type": "string" }, +"speakerLabel": { +"description": "Output only. A distinct string value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word.", +"readOnly": true, +"type": "string" +}, "speakerTag": { "description": "Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled.", "format": "int32", @@ -1831,6 +1836,11 @@ "format": "google-duration", "type": "string" }, +"speakerLabel": { +"description": "Output only. A distinct string value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word.", +"readOnly": true, +"type": "string" +}, "speakerTag": { "description": "Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled.", "format": "int32", @@ -2690,6 +2700,11 @@ "format": "google-duration", "type": "string" }, +"speakerLabel": { +"description": "Output only. A distinct string value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word.", +"readOnly": true, +"type": "string" +}, "speakerTag": { "description": "Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled.", "format": "int32", @@ -3408,6 +3423,10 @@ "description": "Config for SPEECH_TRANSCRIPTION.", "id": "GoogleCloudVideointelligenceV1p2beta1_SpeechTranscriptionConfig", "properties": { +"audioOutputUriPrefix": { +"description": "Optional. Legacy field. This field must be a Cloud Storage URI prefix. (e.g., `gs://bucket/path/`).", +"type": "string" +}, "audioTracks": { "description": "Optional. For file formats, such as MXF or MKV, supporting multiple audio tracks, specify up to two tracks. Default: track 0.", "items": { @@ -3850,6 +3869,11 @@ "format": "google-duration", "type": "string" }, +"speakerLabel": { +"description": "Output only. A distinct string value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word.", +"readOnly": true, +"type": "string" +}, "speakerTag": { "description": "Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled.", "format": "int32", @@ -4842,6 +4866,11 @@ "format": "google-duration", "type": "string" }, +"speakerLabel": { +"description": "Output only. A distinct string value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word.", +"readOnly": true, +"type": "string" +}, "speakerTag": { "description": "Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled.", "format": "int32", diff --git a/googleapiclient/discovery_cache/documents/videointelligence.v1p3beta1.json b/googleapiclient/discovery_cache/documents/videointelligence.v1p3beta1.json index 23045257e3..132112bd05 100644 --- a/googleapiclient/discovery_cache/documents/videointelligence.v1p3beta1.json +++ b/googleapiclient/discovery_cache/documents/videointelligence.v1p3beta1.json @@ -128,7 +128,7 @@ } } }, -"revision": "20250724", +"revision": "20260304", "rootUrl": "https://videointelligence.googleapis.com/", "schemas": { "GoogleCloudVideointelligenceV1_AnnotateVideoProgress": { @@ -972,6 +972,11 @@ "format": "google-duration", "type": "string" }, +"speakerLabel": { +"description": "Output only. A distinct string value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word.", +"readOnly": true, +"type": "string" +}, "speakerTag": { "description": "Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled.", "format": "int32", @@ -1831,6 +1836,11 @@ "format": "google-duration", "type": "string" }, +"speakerLabel": { +"description": "Output only. A distinct string value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word.", +"readOnly": true, +"type": "string" +}, "speakerTag": { "description": "Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled.", "format": "int32", @@ -2690,6 +2700,11 @@ "format": "google-duration", "type": "string" }, +"speakerLabel": { +"description": "Output only. A distinct string value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word.", +"readOnly": true, +"type": "string" +}, "speakerTag": { "description": "Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled.", "format": "int32", @@ -3549,6 +3564,11 @@ "format": "google-duration", "type": "string" }, +"speakerLabel": { +"description": "Output only. A distinct string value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word.", +"readOnly": true, +"type": "string" +}, "speakerTag": { "description": "Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled.", "format": "int32", @@ -4340,6 +4360,10 @@ "description": "Config for SPEECH_TRANSCRIPTION.", "id": "GoogleCloudVideointelligenceV1p3beta1_SpeechTranscriptionConfig", "properties": { +"audioOutputUriPrefix": { +"description": "Optional. Legacy field. This field must be a Cloud Storage URI prefix. (e.g., `gs://bucket/path/`).", +"type": "string" +}, "audioTracks": { "description": "Optional. For file formats, such as MXF or MKV, supporting multiple audio tracks, specify up to two tracks. Default: track 0.", "items": { @@ -4844,6 +4868,11 @@ "format": "google-duration", "type": "string" }, +"speakerLabel": { +"description": "Output only. A distinct string value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word.", +"readOnly": true, +"type": "string" +}, "speakerTag": { "description": "Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled.", "format": "int32", From bfa490980736020521cd6f396a861acddd6aff47 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 10 Mar 2026 07:24:07 +0000 Subject: [PATCH 31/31] chore(docs): Add new discovery artifacts and artifacts with minor updates --- .../admin_directory_v1.chromeosdevices.html | 2 +- ...irectory_v1.customer.devices.chromeos.html | 2 +- docs/dyn/admin_directory_v1.users.html | 4 +- docs/dyn/androidenterprise_v1.devices.html | 8 +- ...bleadmin_v2.projects.instances.tables.html | 12 +- docs/dyn/cloudasset_v1p7beta1.v1p7beta1.html | 2 +- .../dyn/css_v1.accounts.cssProductInputs.html | 8 +- docs/dyn/css_v1.accounts.cssProducts.html | 4 +- ...er_v1.accountTypes.accounts.userLists.html | 12 +- ...ect_v1.projects.locations.connections.html | 8 +- .../developerknowledge_v1alpha.documents.html | 188 +++++++++ docs/dyn/developerknowledge_v1alpha.html | 111 ++++++ ...appdistribution_v1alpha.projects.apps.html | 6 +- ..._v1alpha.projects.apps.releases.tests.html | 16 +- ...ution_v1alpha.projects.apps.testCases.html | 16 +- ...hub_v1.projects.locations.memberships.html | 16 +- .../gkehub_v1.projects.locations.scopes.html | 4 +- ...1alpha.projects.locations.memberships.html | 24 +- ...hub_v1alpha.projects.locations.scopes.html | 4 +- ...v1beta.projects.locations.memberships.html | 16 +- ...ehub_v1beta.projects.locations.scopes.html | 4 +- ...1beta1.projects.locations.memberships.html | 64 ++-- ...ojects.locations.memberships.features.html | 8 +- ...ojects.locations.memberships.features.html | 8 +- ...ojects.locations.memberships.features.html | 8 +- docs/dyn/gkeonprem_v1.projects.locations.html | 4 +- ...ngplatformadmin_v1alpha.organizations.html | 8 +- ...cy_v2.organizations.customConstraints.html | 14 +- ...ubscription_v1.partners.subscriptions.html | 20 +- ...subscription_v1.partners.userSessions.html | 4 +- ...locations.orgPolicyViolationsPreviews.html | 6 +- ...iolationsPreviews.orgPolicyViolations.html | 2 +- ...locations.orgPolicyViolationsPreviews.html | 8 +- ...iolationsPreviews.orgPolicyViolations.html | 2 +- .../dyn/pubsub_v1.projects.subscriptions.html | 12 +- docs/dyn/pubsub_v1.projects.topics.html | 12 +- .../documents/admin.directory_v1.json | 8 +- .../documents/androidenterprise.v1.json | 6 +- .../documents/bigtableadmin.v2.json | 6 +- .../documents/cloudasset.v1p7beta1.json | 4 +- .../discovery_cache/documents/css.v1.json | 4 +- .../documents/datamanager.v1.json | 4 +- .../documents/developerconnect.v1.json | 4 +- .../documents/developerknowledge.v1alpha.json | 280 ++++++++++++++ .../firebaseappdistribution.v1alpha.json | 4 +- .../discovery_cache/documents/gkehub.v1.json | 8 +- .../documents/gkehub.v1alpha.json | 10 +- .../documents/gkehub.v1beta.json | 8 +- .../documents/gkehub.v1beta1.json | 18 +- .../discovery_cache/documents/gkehub.v2.json | 6 +- .../documents/gkehub.v2alpha.json | 6 +- .../documents/gkehub.v2beta.json | 6 +- .../documents/gkeonprem.v1.json | 4 +- .../discovery_cache/documents/iam.v1.json | 8 +- .../documents/language.v1.json | 362 +++++++++++++++++- .../documents/language.v1beta2.json | 362 +++++++++++++++++- .../documents/language.v2.json | 362 +++++++++++++++++- .../marketingplatformadmin.v1alpha.json | 6 +- .../documents/orgpolicy.v2.json | 6 +- .../paymentsresellersubscription.v1.json | 6 +- .../documents/policysimulator.v1.json | 4 +- .../documents/policysimulator.v1alpha.json | 4 +- .../documents/policysimulator.v1beta.json | 4 +- .../discovery_cache/documents/pubsub.v1.json | 4 +- .../discovery_cache/documents/run.v1.json | 14 +- .../discovery_cache/documents/run.v2.json | 14 +- 66 files changed, 1927 insertions(+), 262 deletions(-) create mode 100644 docs/dyn/developerknowledge_v1alpha.documents.html create mode 100644 docs/dyn/developerknowledge_v1alpha.html create mode 100644 googleapiclient/discovery_cache/documents/developerknowledge.v1alpha.json diff --git a/docs/dyn/admin_directory_v1.chromeosdevices.html b/docs/dyn/admin_directory_v1.chromeosdevices.html index bb280743bf..bdbfea5b24 100644 --- a/docs/dyn/admin_directory_v1.chromeosdevices.html +++ b/docs/dyn/admin_directory_v1.chromeosdevices.html @@ -335,7 +335,7 @@

Method Details

Allowed values BASIC - Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user) FULL - Includes all metadata fields - query: string, Search string in the format given at https://developers.google.com/workspace/admin/directory/v1/list-query-operators + query: string, Search string in the format given at [List query operators](https://developers.google.com/workspace/admin/directory/v1/list-query-operators). sortOrder: string, Whether to return results in ascending or descending order. Must be used with the `orderBy` parameter. Allowed values ASCENDING - Ascending order. diff --git a/docs/dyn/admin_directory_v1.customer.devices.chromeos.html b/docs/dyn/admin_directory_v1.customer.devices.chromeos.html index aa3be2d77c..6fa6c1c0da 100644 --- a/docs/dyn/admin_directory_v1.customer.devices.chromeos.html +++ b/docs/dyn/admin_directory_v1.customer.devices.chromeos.html @@ -148,7 +148,7 @@

Method Details

Args: customerId: string, Required. Immutable ID of the Google Workspace account. (required) - filter: string, Optional. Search string in the format given at https://developers.google.com/workspace/admin/directory/v1/list-query-operators + filter: string, Optional. Search string in the format given at [List query operators](https://developers.google.com/workspace/admin/directory/v1/list-query-operators). includeChildOrgunits: boolean, Optional. Return devices from all child orgunits, as well as the specified org unit. If this is set to true, 'orgUnitPath' must be provided. orgUnitPath: string, Optional. The full path of the organizational unit (minus the leading `/`) or its unique ID. x__xgafv: string, V1 error format. diff --git a/docs/dyn/admin_directory_v1.users.html b/docs/dyn/admin_directory_v1.users.html index 07a4711bd4..a6bb41d121 100644 --- a/docs/dyn/admin_directory_v1.users.html +++ b/docs/dyn/admin_directory_v1.users.html @@ -89,7 +89,7 @@

Instance Methods

Close httplib2 connections.

createGuest(body=None, x__xgafv=None)

-

Create a guest user with access to a [subset of Workspace capabilities](https://support.google.com/a/answer/16558545?hl=en). This feature is currently in Alpha. Please reach out to support if you are interested in trying this feature.

+

Create a guest user with access to a [subset of Workspace capabilities](https://support.google.com/a/answer/16558545). This feature is currently in Alpha. Please reach out to support if you are interested in trying this feature.

delete(userKey, x__xgafv=None)

Deletes a user.

@@ -131,7 +131,7 @@

Method Details

createGuest(body=None, x__xgafv=None) -
Create a guest user with access to a [subset of Workspace capabilities](https://support.google.com/a/answer/16558545?hl=en). This feature is currently in Alpha. Please reach out to support if you are interested in trying this feature.
+  
Create a guest user with access to a [subset of Workspace capabilities](https://support.google.com/a/answer/16558545). This feature is currently in Alpha. Please reach out to support if you are interested in trying this feature.
 
 Args:
   body: object, The request body.
diff --git a/docs/dyn/androidenterprise_v1.devices.html b/docs/dyn/androidenterprise_v1.devices.html
index d530f6ca93..3d7df68928 100644
--- a/docs/dyn/androidenterprise_v1.devices.html
+++ b/docs/dyn/androidenterprise_v1.devices.html
@@ -85,13 +85,13 @@ 

Instance Methods

Retrieves the details of a device.

getState(enterpriseId, userId, deviceId, x__xgafv=None)

-

Retrieves whether a device's access to Google services is enabled or disabled. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. This is only supported for Google-managed users.

+

Checks if a device can access Google apps and services for a user. Returns whether access is "enabled" or "disabled". A "disabled" state prevents the user's Managed Google Account on the device from successfully authenticating with Google. This blocks access to most Google applications and services, including Google Play, as the device cannot prove its entitlement to access them. New devices default to "disabled". Important: Enforcement of this state depends on the following conditions: * The user must be a managed google account. * The enterprise must be a managed google domain. * Third-party Android mobile management must be active in the Google Admin Console for the user's Organizational Unit. If these conditions aren't met, access may still be possible even in a "disabled" state.

list(enterpriseId, userId, x__xgafv=None)

Retrieves the IDs of all of a user's devices.

setState(enterpriseId, userId, deviceId, body=None, x__xgafv=None)

-

Sets whether a device's access to Google services is enabled or disabled. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. This is only supported for Google-managed users.

+

Sets whether a device's access to Google services (including Google Play) is enabled or disabled for the specified user. Setting the state to "enabled" allows the Google Account to access Google services, while "disabled" blocks access by preventing OAuth token issuance. Preconditions for Enforcement: 1. This setting is only effective for Google-managed users. 2. The enterprise must be linked to a Google Managed Domain. 3. Enforcement requires third-party Android mobile management to be enabled within the Google Admin Console for the user's Organizational Unit. If these preconditions are not met, changes to this state may be ignored.

update(enterpriseId, userId, deviceId, body=None, updateMask=None, x__xgafv=None)

Updates the device policy. To ensure the policy is properly enforced, you need to prevent unmanaged accounts from accessing Google Play by setting the allowed_accounts in the managed configuration for the Google Play package. See restrict accounts in Google Play. When provisioning a new device, you should set the device policy using this method before adding the managed Google Play Account to the device, otherwise the policy will not be applied for a short period of time after adding the account to the device.

@@ -239,7 +239,7 @@

Method Details

getState(enterpriseId, userId, deviceId, x__xgafv=None) -
Retrieves whether a device's access to Google services is enabled or disabled. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. This is only supported for Google-managed users.
+  
Checks if a device can access Google apps and services for a user. Returns whether access is "enabled" or "disabled". A "disabled" state prevents the user's Managed Google Account on the device from successfully authenticating with Google. This blocks access to most Google applications and services, including Google Play, as the device cannot prove its entitlement to access them. New devices default to "disabled". Important: Enforcement of this state depends on the following conditions: * The user must be a managed google account. * The enterprise must be a managed google domain. * Third-party Android mobile management must be active in the Google Admin Console for the user's Organizational Unit. If these conditions aren't met, access may still be possible even in a "disabled" state.
 
 Args:
   enterpriseId: string, The ID of the enterprise. (required)
@@ -384,7 +384,7 @@ 

Method Details

setState(enterpriseId, userId, deviceId, body=None, x__xgafv=None) -
Sets whether a device's access to Google services is enabled or disabled. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. This is only supported for Google-managed users.
+  
Sets whether a device's access to Google services (including Google Play) is enabled or disabled for the specified user. Setting the state to "enabled" allows the Google Account to access Google services, while "disabled" blocks access by preventing OAuth token issuance. Preconditions for Enforcement: 1. This setting is only effective for Google-managed users. 2. The enterprise must be linked to a Google Managed Domain. 3. Enforcement requires third-party Android mobile management to be enabled within the Google Admin Console for the user's Organizational Unit. If these preconditions are not met, changes to this state may be ignored.
 
 Args:
   enterpriseId: string, The ID of the enterprise. (required)
diff --git a/docs/dyn/bigtableadmin_v2.projects.instances.tables.html b/docs/dyn/bigtableadmin_v2.projects.instances.tables.html
index afb8e5487a..ece6e9c093 100644
--- a/docs/dyn/bigtableadmin_v2.projects.instances.tables.html
+++ b/docs/dyn/bigtableadmin_v2.projects.instances.tables.html
@@ -339,7 +339,7 @@ 

Method Details

}, }, "deletionProtection": True or False, # Set to true to make the table protected against data loss. i.e. deleting the following resources through Admin APIs are prohibited: * The table. * The column families in the table. * The instance containing the table. Note one can still delete the data stored in the table through Data APIs. - "granularity": "A String", # Immutable. The granularity (i.e. `MILLIS`) at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set to `MILLIS`. Views: `SCHEMA_VIEW`, `FULL`. + "granularity": "A String", # Immutable. The granularity at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set to `MILLIS`. Views: `SCHEMA_VIEW`, `FULL`. "name": "A String", # The unique name of the table. Values are of the form `projects/{project}/instances/{instance}/tables/_a-zA-Z0-9*`. Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `STATS_VIEW`, `FULL` "restoreInfo": { # Information about a table restore. # Output only. If this table was restored from another data source (e.g. a backup), this field will be populated with information about the restore. "backupInfo": { # Information about a backup. # Information about the backup used to restore the table. The backup may no longer exist. @@ -547,7 +547,7 @@

Method Details

}, }, "deletionProtection": True or False, # Set to true to make the table protected against data loss. i.e. deleting the following resources through Admin APIs are prohibited: * The table. * The column families in the table. * The instance containing the table. Note one can still delete the data stored in the table through Data APIs. - "granularity": "A String", # Immutable. The granularity (i.e. `MILLIS`) at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set to `MILLIS`. Views: `SCHEMA_VIEW`, `FULL`. + "granularity": "A String", # Immutable. The granularity at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set to `MILLIS`. Views: `SCHEMA_VIEW`, `FULL`. "name": "A String", # The unique name of the table. Values are of the form `projects/{project}/instances/{instance}/tables/_a-zA-Z0-9*`. Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `STATS_VIEW`, `FULL` "restoreInfo": { # Information about a table restore. # Output only. If this table was restored from another data source (e.g. a backup), this field will be populated with information about the restore. "backupInfo": { # Information about a backup. # Information about the backup used to restore the table. The backup may no longer exist. @@ -838,7 +838,7 @@

Method Details

}, }, "deletionProtection": True or False, # Set to true to make the table protected against data loss. i.e. deleting the following resources through Admin APIs are prohibited: * The table. * The column families in the table. * The instance containing the table. Note one can still delete the data stored in the table through Data APIs. - "granularity": "A String", # Immutable. The granularity (i.e. `MILLIS`) at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set to `MILLIS`. Views: `SCHEMA_VIEW`, `FULL`. + "granularity": "A String", # Immutable. The granularity at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set to `MILLIS`. Views: `SCHEMA_VIEW`, `FULL`. "name": "A String", # The unique name of the table. Values are of the form `projects/{project}/instances/{instance}/tables/_a-zA-Z0-9*`. Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `STATS_VIEW`, `FULL` "restoreInfo": { # Information about a table restore. # Output only. If this table was restored from another data source (e.g. a backup), this field will be populated with information about the restore. "backupInfo": { # Information about a backup. # Information about the backup used to restore the table. The backup may no longer exist. @@ -1121,7 +1121,7 @@

Method Details

}, }, "deletionProtection": True or False, # Set to true to make the table protected against data loss. i.e. deleting the following resources through Admin APIs are prohibited: * The table. * The column families in the table. * The instance containing the table. Note one can still delete the data stored in the table through Data APIs. - "granularity": "A String", # Immutable. The granularity (i.e. `MILLIS`) at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set to `MILLIS`. Views: `SCHEMA_VIEW`, `FULL`. + "granularity": "A String", # Immutable. The granularity at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set to `MILLIS`. Views: `SCHEMA_VIEW`, `FULL`. "name": "A String", # The unique name of the table. Values are of the form `projects/{project}/instances/{instance}/tables/_a-zA-Z0-9*`. Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `STATS_VIEW`, `FULL` "restoreInfo": { # Information about a table restore. # Output only. If this table was restored from another data source (e.g. a backup), this field will be populated with information about the restore. "backupInfo": { # Information about a backup. # Information about the backup used to restore the table. The backup may no longer exist. @@ -1614,7 +1614,7 @@

Method Details

}, }, "deletionProtection": True or False, # Set to true to make the table protected against data loss. i.e. deleting the following resources through Admin APIs are prohibited: * The table. * The column families in the table. * The instance containing the table. Note one can still delete the data stored in the table through Data APIs. - "granularity": "A String", # Immutable. The granularity (i.e. `MILLIS`) at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set to `MILLIS`. Views: `SCHEMA_VIEW`, `FULL`. + "granularity": "A String", # Immutable. The granularity at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set to `MILLIS`. Views: `SCHEMA_VIEW`, `FULL`. "name": "A String", # The unique name of the table. Values are of the form `projects/{project}/instances/{instance}/tables/_a-zA-Z0-9*`. Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `STATS_VIEW`, `FULL` "restoreInfo": { # Information about a table restore. # Output only. If this table was restored from another data source (e.g. a backup), this field will be populated with information about the restore. "backupInfo": { # Information about a backup. # Information about the backup used to restore the table. The backup may no longer exist. @@ -1822,7 +1822,7 @@

Method Details

}, }, "deletionProtection": True or False, # Set to true to make the table protected against data loss. i.e. deleting the following resources through Admin APIs are prohibited: * The table. * The column families in the table. * The instance containing the table. Note one can still delete the data stored in the table through Data APIs. - "granularity": "A String", # Immutable. The granularity (i.e. `MILLIS`) at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set to `MILLIS`. Views: `SCHEMA_VIEW`, `FULL`. + "granularity": "A String", # Immutable. The granularity at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set to `MILLIS`. Views: `SCHEMA_VIEW`, `FULL`. "name": "A String", # The unique name of the table. Values are of the form `projects/{project}/instances/{instance}/tables/_a-zA-Z0-9*`. Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `STATS_VIEW`, `FULL` "restoreInfo": { # Information about a table restore. # Output only. If this table was restored from another data source (e.g. a backup), this field will be populated with information about the restore. "backupInfo": { # Information about a backup. # Information about the backup used to restore the table. The backup may no longer exist. diff --git a/docs/dyn/cloudasset_v1p7beta1.v1p7beta1.html b/docs/dyn/cloudasset_v1p7beta1.v1p7beta1.html index 3ab5f5c6ed..26eae1d047 100644 --- a/docs/dyn/cloudasset_v1p7beta1.v1p7beta1.html +++ b/docs/dyn/cloudasset_v1p7beta1.v1p7beta1.html @@ -111,7 +111,7 @@

Method Details

"table": "A String", # Required. The BigQuery table to which the snapshot result should be written. If this table does not exist, a new table with the given name will be created. }, "gcsDestination": { # A Cloud Storage location. # Destination on Cloud Storage. - "uri": "A String", # The URI of the Cloud Storage object. It's the same URI that is used by gsutil. Example: "gs://bucket_name/object_name". See [Viewing and Editing Object Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata) for more information. + "uri": "A String", # The URI of the Cloud Storage object. It's the same URI that is used by gcloud storage. Example: "gs://bucket_name/object_name". See [Viewing and Editing Object Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata) for more information. "uriPrefix": "A String", # The URI prefix of all generated Cloud Storage objects. Example: "gs://bucket_name/object_name_prefix". Each object URI is in format: "gs://bucket_name/object_name_prefix/{ASSET_TYPE}/{SHARD_NUMBER} and only contains assets for that type. starts from 0. Example: "gs://bucket_name/object_name_prefix/compute.googleapis.com/Disk/0" is the first shard of output objects containing all compute.googleapis.com/Disk assets. An INVALID_ARGUMENT error will be returned if file with the same name "gs://bucket_name/object_name_prefix" already exists. }, }, diff --git a/docs/dyn/css_v1.accounts.cssProductInputs.html b/docs/dyn/css_v1.accounts.cssProductInputs.html index 008379d889..fe27498767 100644 --- a/docs/dyn/css_v1.accounts.cssProductInputs.html +++ b/docs/dyn/css_v1.accounts.cssProductInputs.html @@ -233,7 +233,7 @@

Method Details

}, "size": "A String", # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see [https://support.google.com/merchants/answer/6324492](size definition)). "sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items. - "sizeTypes": [ # The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided (see [https://support.google.com/merchants/answer/6324497](size type)). + "sizeTypes": [ # The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided (see [size type](https://support.google.com/merchants/answer/6324497). "A String", ], "title": "A String", # Title of the item. @@ -377,7 +377,7 @@

Method Details

}, "size": "A String", # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see [https://support.google.com/merchants/answer/6324492](size definition)). "sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items. - "sizeTypes": [ # The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided (see [https://support.google.com/merchants/answer/6324497](size type)). + "sizeTypes": [ # The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided (see [size type](https://support.google.com/merchants/answer/6324497). "A String", ], "title": "A String", # Title of the item. @@ -522,7 +522,7 @@

Method Details

}, "size": "A String", # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see [https://support.google.com/merchants/answer/6324492](size definition)). "sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items. - "sizeTypes": [ # The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided (see [https://support.google.com/merchants/answer/6324497](size type)). + "sizeTypes": [ # The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided (see [size type](https://support.google.com/merchants/answer/6324497). "A String", ], "title": "A String", # Title of the item. @@ -666,7 +666,7 @@

Method Details

}, "size": "A String", # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see [https://support.google.com/merchants/answer/6324492](size definition)). "sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items. - "sizeTypes": [ # The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided (see [https://support.google.com/merchants/answer/6324497](size type)). + "sizeTypes": [ # The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided (see [size type](https://support.google.com/merchants/answer/6324497). "A String", ], "title": "A String", # Title of the item. diff --git a/docs/dyn/css_v1.accounts.cssProducts.html b/docs/dyn/css_v1.accounts.cssProducts.html index 20993616f2..d6790d4587 100644 --- a/docs/dyn/css_v1.accounts.cssProducts.html +++ b/docs/dyn/css_v1.accounts.cssProducts.html @@ -219,7 +219,7 @@

Method Details

}, "size": "A String", # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see [https://support.google.com/merchants/answer/6324492](size definition)). "sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items. - "sizeTypes": [ # The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided (see [https://support.google.com/merchants/answer/6324497](size type)). + "sizeTypes": [ # The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided (see [size type](https://support.google.com/merchants/answer/6324497). "A String", ], "title": "A String", # Title of the item. @@ -405,7 +405,7 @@

Method Details

}, "size": "A String", # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see [https://support.google.com/merchants/answer/6324492](size definition)). "sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items. - "sizeTypes": [ # The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided (see [https://support.google.com/merchants/answer/6324497](size type)). + "sizeTypes": [ # The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided (see [size type](https://support.google.com/merchants/answer/6324497). "A String", ], "title": "A String", # Title of the item. diff --git a/docs/dyn/datamanager_v1.accountTypes.accounts.userLists.html b/docs/dyn/datamanager_v1.accountTypes.accounts.userLists.html index b5e37dfbb4..7f42e2ba39 100644 --- a/docs/dyn/datamanager_v1.accountTypes.accounts.userLists.html +++ b/docs/dyn/datamanager_v1.accountTypes.accounts.userLists.html @@ -130,7 +130,7 @@

Method Details

"pairIdInfo": { # Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. # Optional. Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. "advertiserIdentifierCount": "A String", # Optional. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list. "cleanRoomIdentifier": "A String", # Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers. - "matchRatePercentage": 42, # Optional. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive. + "matchRatePercentage": 42, # Required. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive. "publisherId": "A String", # Required. Immutable. Identifies the publisher that the Publisher Advertiser Identity Reconciliation user list is reconciled with. This field is provided by the cleanroom provider and is only unique in the scope of that cleanroom. This cannot be used as a global identifier across multiple cleanrooms. "publisherName": "A String", # Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience. }, @@ -193,7 +193,7 @@

Method Details

"pairIdInfo": { # Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. # Optional. Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. "advertiserIdentifierCount": "A String", # Optional. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list. "cleanRoomIdentifier": "A String", # Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers. - "matchRatePercentage": 42, # Optional. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive. + "matchRatePercentage": 42, # Required. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive. "publisherId": "A String", # Required. Immutable. Identifies the publisher that the Publisher Advertiser Identity Reconciliation user list is reconciled with. This field is provided by the cleanroom provider and is only unique in the scope of that cleanroom. This cannot be used as a global identifier across multiple cleanrooms. "publisherName": "A String", # Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience. }, @@ -281,7 +281,7 @@

Method Details

"pairIdInfo": { # Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. # Optional. Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. "advertiserIdentifierCount": "A String", # Optional. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list. "cleanRoomIdentifier": "A String", # Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers. - "matchRatePercentage": 42, # Optional. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive. + "matchRatePercentage": 42, # Required. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive. "publisherId": "A String", # Required. Immutable. Identifies the publisher that the Publisher Advertiser Identity Reconciliation user list is reconciled with. This field is provided by the cleanroom provider and is only unique in the scope of that cleanroom. This cannot be used as a global identifier across multiple cleanrooms. "publisherName": "A String", # Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience. }, @@ -356,7 +356,7 @@

Method Details

"pairIdInfo": { # Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. # Optional. Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. "advertiserIdentifierCount": "A String", # Optional. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list. "cleanRoomIdentifier": "A String", # Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers. - "matchRatePercentage": 42, # Optional. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive. + "matchRatePercentage": 42, # Required. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive. "publisherId": "A String", # Required. Immutable. Identifies the publisher that the Publisher Advertiser Identity Reconciliation user list is reconciled with. This field is provided by the cleanroom provider and is only unique in the scope of that cleanroom. This cannot be used as a global identifier across multiple cleanrooms. "publisherName": "A String", # Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience. }, @@ -436,7 +436,7 @@

Method Details

"pairIdInfo": { # Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. # Optional. Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. "advertiserIdentifierCount": "A String", # Optional. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list. "cleanRoomIdentifier": "A String", # Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers. - "matchRatePercentage": 42, # Optional. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive. + "matchRatePercentage": 42, # Required. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive. "publisherId": "A String", # Required. Immutable. Identifies the publisher that the Publisher Advertiser Identity Reconciliation user list is reconciled with. This field is provided by the cleanroom provider and is only unique in the scope of that cleanroom. This cannot be used as a global identifier across multiple cleanrooms. "publisherName": "A String", # Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience. }, @@ -500,7 +500,7 @@

Method Details

"pairIdInfo": { # Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. # Optional. Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. "advertiserIdentifierCount": "A String", # Optional. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list. "cleanRoomIdentifier": "A String", # Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers. - "matchRatePercentage": 42, # Optional. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive. + "matchRatePercentage": 42, # Required. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive. "publisherId": "A String", # Required. Immutable. Identifies the publisher that the Publisher Advertiser Identity Reconciliation user list is reconciled with. This field is provided by the cleanroom provider and is only unique in the scope of that cleanroom. This cannot be used as a global identifier across multiple cleanrooms. "publisherName": "A String", # Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience. }, diff --git a/docs/dyn/developerconnect_v1.projects.locations.connections.html b/docs/dyn/developerconnect_v1.projects.locations.connections.html index 49c2e22fef..fab61ad93f 100644 --- a/docs/dyn/developerconnect_v1.projects.locations.connections.html +++ b/docs/dyn/developerconnect_v1.projects.locations.connections.html @@ -167,7 +167,7 @@

Method Details

"deleteTime": "A String", # Output only. [Output only] Delete timestamp "disabled": True or False, # Optional. If disabled is set to true, functionality is disabled for this connection. Repository based API methods and webhooks processing for repositories in this connection will be disabled. "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "gitProxyConfig": { # The git proxy configuration. # Optional. Configuration for the git proxy feature. Enabling the git proxy allows clients to perform git operations on the repositories linked in the connection. + "gitProxyConfig": { # The git proxy configuration. # Optional. Configuration for the git proxy feature. Enabling the git proxy allows clients to perform git operations on the repositories linked in the connection. [Learn more](https://docs.cloud.google.com/developer-connect/docs/configure-git-proxy). "enabled": True or False, # Optional. Setting this to true allows the git proxy to be used for performing git operations on the repositories linked in the connection. "httpProxyBaseUri": "A String", # Output only. The base URI for the HTTP proxy endpoint. Has the format `https://{generatedID}-c-h-{shortRegion}.developerconnect.dev` Populated only when enabled is set to true. This endpoint is used by other Google services that integrate with Developer Connect. }, @@ -443,7 +443,7 @@

Method Details

"deleteTime": "A String", # Output only. [Output only] Delete timestamp "disabled": True or False, # Optional. If disabled is set to true, functionality is disabled for this connection. Repository based API methods and webhooks processing for repositories in this connection will be disabled. "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "gitProxyConfig": { # The git proxy configuration. # Optional. Configuration for the git proxy feature. Enabling the git proxy allows clients to perform git operations on the repositories linked in the connection. + "gitProxyConfig": { # The git proxy configuration. # Optional. Configuration for the git proxy feature. Enabling the git proxy allows clients to perform git operations on the repositories linked in the connection. [Learn more](https://docs.cloud.google.com/developer-connect/docs/configure-git-proxy). "enabled": True or False, # Optional. Setting this to true allows the git proxy to be used for performing git operations on the repositories linked in the connection. "httpProxyBaseUri": "A String", # Output only. The base URI for the HTTP proxy endpoint. Has the format `https://{generatedID}-c-h-{shortRegion}.developerconnect.dev` Populated only when enabled is set to true. This endpoint is used by other Google services that integrate with Developer Connect. }, @@ -591,7 +591,7 @@

Method Details

"deleteTime": "A String", # Output only. [Output only] Delete timestamp "disabled": True or False, # Optional. If disabled is set to true, functionality is disabled for this connection. Repository based API methods and webhooks processing for repositories in this connection will be disabled. "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "gitProxyConfig": { # The git proxy configuration. # Optional. Configuration for the git proxy feature. Enabling the git proxy allows clients to perform git operations on the repositories linked in the connection. + "gitProxyConfig": { # The git proxy configuration. # Optional. Configuration for the git proxy feature. Enabling the git proxy allows clients to perform git operations on the repositories linked in the connection. [Learn more](https://docs.cloud.google.com/developer-connect/docs/configure-git-proxy). "enabled": True or False, # Optional. Setting this to true allows the git proxy to be used for performing git operations on the repositories linked in the connection. "httpProxyBaseUri": "A String", # Output only. The base URI for the HTTP proxy endpoint. Has the format `https://{generatedID}-c-h-{shortRegion}.developerconnect.dev` Populated only when enabled is set to true. This endpoint is used by other Google services that integrate with Developer Connect. }, @@ -748,7 +748,7 @@

Method Details

"deleteTime": "A String", # Output only. [Output only] Delete timestamp "disabled": True or False, # Optional. If disabled is set to true, functionality is disabled for this connection. Repository based API methods and webhooks processing for repositories in this connection will be disabled. "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "gitProxyConfig": { # The git proxy configuration. # Optional. Configuration for the git proxy feature. Enabling the git proxy allows clients to perform git operations on the repositories linked in the connection. + "gitProxyConfig": { # The git proxy configuration. # Optional. Configuration for the git proxy feature. Enabling the git proxy allows clients to perform git operations on the repositories linked in the connection. [Learn more](https://docs.cloud.google.com/developer-connect/docs/configure-git-proxy). "enabled": True or False, # Optional. Setting this to true allows the git proxy to be used for performing git operations on the repositories linked in the connection. "httpProxyBaseUri": "A String", # Output only. The base URI for the HTTP proxy endpoint. Has the format `https://{generatedID}-c-h-{shortRegion}.developerconnect.dev` Populated only when enabled is set to true. This endpoint is used by other Google services that integrate with Developer Connect. }, diff --git a/docs/dyn/developerknowledge_v1alpha.documents.html b/docs/dyn/developerknowledge_v1alpha.documents.html new file mode 100644 index 0000000000..821d2b7d1e --- /dev/null +++ b/docs/dyn/developerknowledge_v1alpha.documents.html @@ -0,0 +1,188 @@ + + + +

Developer Knowledge API . documents

+

Instance Methods

+

+ batchGet(names=None, x__xgafv=None)

+

Retrieves multiple documents, each with its full Markdown content.

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Retrieves a single document with its full Markdown content.

+

+ searchDocumentChunks(pageSize=None, pageToken=None, query=None, x__xgafv=None)

+

Searches for developer knowledge across Google's developer documentation. This method returns document chunks based on the user's query. There can be many chunks of the same Document. To retrieve full documents, use DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments with the DocumentChunk.parent returned in the SearchDocumentChunksResponse.results.

+

+ searchDocumentChunks_next()

+

Retrieves the next page of results.

+

Method Details

+
+ batchGet(names=None, x__xgafv=None) +
Retrieves multiple documents, each with its full Markdown content.
+
+Args:
+  names: string, Required. The names of the documents to retrieve. A maximum of 20 documents can be retrieved in a batch. The documents are returned in the same order as the `names` in the request. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` (repeated)
+  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 DeveloperKnowledge.BatchGetDocuments.
+  "documents": [ # Documents requested.
+    { # A Document represents a piece of content from the Developer Knowledge corpus.
+      "content": "A String", # Output only. The full content of the document in Markdown format.
+      "description": "A String", # Output only. A description of the document.
+      "name": "A String", # Identifier. The resource name of the document. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets`
+      "uri": "A String", # Output only. The URI of the content, such as `docs.cloud.google.com/storage/docs/creating-buckets`.
+    },
+  ],
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Retrieves a single document with its full Markdown content.
+
+Args:
+  name: string, Required. The name of the document to retrieve. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A Document represents a piece of content from the Developer Knowledge corpus.
+  "content": "A String", # Output only. The full content of the document in Markdown format.
+  "description": "A String", # Output only. A description of the document.
+  "name": "A String", # Identifier. The resource name of the document. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets`
+  "uri": "A String", # Output only. The URI of the content, such as `docs.cloud.google.com/storage/docs/creating-buckets`.
+}
+
+ +
+ searchDocumentChunks(pageSize=None, pageToken=None, query=None, x__xgafv=None) +
Searches for developer knowledge across Google's developer documentation. This method returns document chunks based on the user's query. There can be many chunks of the same Document. To retrieve full documents, use DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments with the DocumentChunk.parent returned in the SearchDocumentChunksResponse.results.
+
+Args:
+  pageSize: integer, Optional. The maximum number of results to return. The service may return fewer than this value. If unspecified, at most 5 results will be returned. The maximum value is 20; values above 20 will result in an INVALID_ARGUMENT error.
+  pageToken: string, Optional. A page token, received from a previous `SearchDocumentChunks` call. Provide this to retrieve the subsequent page.
+  query: string, Required. The raw query string provided by the user, such as "How to create a Cloud Storage bucket?".
+  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 DeveloperKnowledge.SearchDocumentChunks.
+  "nextPageToken": "A String", # Optional. A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+  "results": [ # The search results for the given query. Each DocumentChunk in this list contains a snippet of content relevant to the search query. Use the DocumentChunk.parent field of each result with DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments to retrieve the full document content.
+    { # A DocumentChunk represents a piece of content from a Document in the DeveloperKnowledge corpus. To fetch the entire document content, pass the `parent` to DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments.
+      "content": "A String", # Output only. The content of the document chunk.
+      "id": "A String", # Output only. The ID of this chunk within the document. The chunk ID is unique within a document, but not globally unique across documents. The chunk ID is not stable and may change over time.
+      "parent": "A String", # Output only. The resource name of the document this chunk is from. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets`
+    },
+  ],
+}
+
+ +
+ searchDocumentChunks_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/developerknowledge_v1alpha.html b/docs/dyn/developerknowledge_v1alpha.html new file mode 100644 index 0000000000..399cdf72f7 --- /dev/null +++ b/docs/dyn/developerknowledge_v1alpha.html @@ -0,0 +1,111 @@ + + + +

Developer Knowledge API

+

Instance Methods

+

+ documents() +

+

Returns the documents 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/firebaseappdistribution_v1alpha.projects.apps.html b/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.html index 681f6fc75d..f8ad11d15c 100644 --- a/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.html +++ b/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.html @@ -123,7 +123,7 @@

Method Details

"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 + "successCriteria": "A String", # Optional. A visual description of the screen's expected state after the step has been successfully completed. This is referred to as the "final screen assertion" in the Firebase console and CLI tools. This field must be provided for the last step in a test case, and is optional for all other steps. "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}` }, ], @@ -168,7 +168,7 @@

Method Details

"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 + "successCriteria": "A String", # Optional. A visual description of the screen's expected state after the step has been successfully completed. This is referred to as the "final screen assertion" in the Firebase console and CLI tools. This field must be provided for the last step in a test case, and is optional for all other steps. "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}` }, ], @@ -212,7 +212,7 @@

Method Details

"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 + "successCriteria": "A String", # Optional. A visual description of the screen's expected state after the step has been successfully completed. This is referred to as the "final screen assertion" in the Firebase console and CLI tools. This field must be provided for the last step in a test case, and is optional for all other steps. "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}` }, ], diff --git a/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.releases.tests.html b/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.releases.tests.html index 60da342ce8..29de52290d 100644 --- a/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.releases.tests.html +++ b/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.releases.tests.html @@ -132,7 +132,7 @@

Method Details

"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 + "successCriteria": "A String", # Optional. A visual description of the screen's expected state after the step has been successfully completed. This is referred to as the "final screen assertion" in the Firebase console and CLI tools. This field must be provided for the last step in a test case, and is optional for all other steps. "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}` }, ], @@ -233,7 +233,7 @@

Method Details

"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 + "successCriteria": "A String", # Optional. A visual description of the screen's expected state after the step has been successfully completed. This is referred to as the "final screen assertion" in the Firebase console and CLI tools. This field must be provided for the last step in a test case, and is optional for all other steps. "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}` }, }, @@ -301,7 +301,7 @@

Method Details

"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 + "successCriteria": "A String", # Optional. A visual description of the screen's expected state after the step has been successfully completed. This is referred to as the "final screen assertion" in the Firebase console and CLI tools. This field must be provided for the last step in a test case, and is optional for all other steps. "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}` }, ], @@ -402,7 +402,7 @@

Method Details

"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 + "successCriteria": "A String", # Optional. A visual description of the screen's expected state after the step has been successfully completed. This is referred to as the "final screen assertion" in the Firebase console and CLI tools. This field must be provided for the last step in a test case, and is optional for all other steps. "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}` }, }, @@ -476,7 +476,7 @@

Method Details

"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 + "successCriteria": "A String", # Optional. A visual description of the screen's expected state after the step has been successfully completed. This is referred to as the "final screen assertion" in the Firebase console and CLI tools. This field must be provided for the last step in a test case, and is optional for all other steps. "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}` }, ], @@ -577,7 +577,7 @@

Method Details

"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 + "successCriteria": "A String", # Optional. A visual description of the screen's expected state after the step has been successfully completed. This is referred to as the "final screen assertion" in the Firebase console and CLI tools. This field must be provided for the last step in a test case, and is optional for all other steps. "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}` }, }, @@ -661,7 +661,7 @@

Method Details

"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 + "successCriteria": "A String", # Optional. A visual description of the screen's expected state after the step has been successfully completed. This is referred to as the "final screen assertion" in the Firebase console and CLI tools. This field must be provided for the last step in a test case, and is optional for all other steps. "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}` }, ], @@ -762,7 +762,7 @@

Method Details

"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 + "successCriteria": "A String", # Optional. A visual description of the screen's expected state after the step has been successfully completed. This is referred to as the "final screen assertion" in the Firebase console and CLI tools. This field must be provided for the last step in a test case, and is optional for all other steps. "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}` }, }, diff --git a/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.testCases.html b/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.testCases.html index c738a003b8..aa9101dde1 100644 --- a/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.testCases.html +++ b/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.testCases.html @@ -152,7 +152,7 @@

Method Details

"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 + "successCriteria": "A String", # Optional. A visual description of the screen's expected state after the step has been successfully completed. This is referred to as the "final screen assertion" in the Firebase console and CLI tools. This field must be provided for the last step in a test case, and is optional for all other steps. "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}` }, ], @@ -186,7 +186,7 @@

Method Details

"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 + "successCriteria": "A String", # Optional. A visual description of the screen's expected state after the step has been successfully completed. This is referred to as the "final screen assertion" in the Firebase console and CLI tools. This field must be provided for the last step in a test case, and is optional for all other steps. "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}` }, ], @@ -256,7 +256,7 @@

Method Details

"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 + "successCriteria": "A String", # Optional. A visual description of the screen's expected state after the step has been successfully completed. This is referred to as the "final screen assertion" in the Firebase console and CLI tools. This field must be provided for the last step in a test case, and is optional for all other steps. "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}` }, ], @@ -286,7 +286,7 @@

Method Details

"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 + "successCriteria": "A String", # Optional. A visual description of the screen's expected state after the step has been successfully completed. This is referred to as the "final screen assertion" in the Firebase console and CLI tools. This field must be provided for the last step in a test case, and is optional for all other steps. "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}` }, ], @@ -340,7 +340,7 @@

Method Details

"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 + "successCriteria": "A String", # Optional. A visual description of the screen's expected state after the step has been successfully completed. This is referred to as the "final screen assertion" in the Firebase console and CLI tools. This field must be provided for the last step in a test case, and is optional for all other steps. "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}` }, ], @@ -381,7 +381,7 @@

Method Details

"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 + "successCriteria": "A String", # Optional. A visual description of the screen's expected state after the step has been successfully completed. This is referred to as the "final screen assertion" in the Firebase console and CLI tools. This field must be provided for the last step in a test case, and is optional for all other steps. "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}` }, ], @@ -428,7 +428,7 @@

Method Details

"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 + "successCriteria": "A String", # Optional. A visual description of the screen's expected state after the step has been successfully completed. This is referred to as the "final screen assertion" in the Firebase console and CLI tools. This field must be provided for the last step in a test case, and is optional for all other steps. "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}` }, ], @@ -458,7 +458,7 @@

Method Details

"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 + "successCriteria": "A String", # Optional. A visual description of the screen's expected state after the step has been successfully completed. This is referred to as the "final screen assertion" in the Firebase console and CLI tools. This field must be provided for the last step in a test case, and is optional for all other steps. "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}` }, ], diff --git a/docs/dyn/gkehub_v1.projects.locations.memberships.html b/docs/dyn/gkehub_v1.projects.locations.memberships.html index cc19dc6748..d37f4346b3 100644 --- a/docs/dyn/gkehub_v1.projects.locations.memberships.html +++ b/docs/dyn/gkehub_v1.projects.locations.memberships.html @@ -152,7 +152,7 @@

Method Details

"edgeCluster": { # EdgeCluster contains information specific to Google Edge Clusters. # Optional. Specific information for a Google Edge cluster. "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the Edge Cluster. For example: //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster }, - "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE-on-GCP cluster. + "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE on Google Cloud cluster. "clusterMissing": True or False, # Output only. If cluster_missing is set then it denotes that the GKE cluster no longer exists in the GKE Control Plane. "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the GKE cluster. For example: //container.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster Zonal clusters are also supported. }, @@ -161,7 +161,7 @@

Method Details

"kubernetesApiServerVersion": "A String", # Output only. Kubernetes API server version string as reported by `/version`. "memoryMb": 42, # Output only. The total memory capacity as reported by the sum of all Kubernetes nodes resources, defined in MB. "nodeCount": 42, # Output only. Node count as reported by Kubernetes nodes resources. - "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the node_count will be zero and the node_provider_id will be empty. + "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE on Google Cloud), the node_count will be zero and the node_provider_id will be empty. "updateTime": "A String", # Output only. The time at which these details were last updated. This update_time is different from the Membership-level update_time since EndpointDetails are updated internally for API consumers. "vcpuCount": 42, # Output only. vCPU count as reported by Kubernetes nodes resources. }, @@ -353,7 +353,7 @@

Method Details

"edgeCluster": { # EdgeCluster contains information specific to Google Edge Clusters. # Optional. Specific information for a Google Edge cluster. "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the Edge Cluster. For example: //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster }, - "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE-on-GCP cluster. + "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE on Google Cloud cluster. "clusterMissing": True or False, # Output only. If cluster_missing is set then it denotes that the GKE cluster no longer exists in the GKE Control Plane. "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the GKE cluster. For example: //container.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster Zonal clusters are also supported. }, @@ -362,7 +362,7 @@

Method Details

"kubernetesApiServerVersion": "A String", # Output only. Kubernetes API server version string as reported by `/version`. "memoryMb": 42, # Output only. The total memory capacity as reported by the sum of all Kubernetes nodes resources, defined in MB. "nodeCount": 42, # Output only. Node count as reported by Kubernetes nodes resources. - "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the node_count will be zero and the node_provider_id will be empty. + "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE on Google Cloud), the node_count will be zero and the node_provider_id will be empty. "updateTime": "A String", # Output only. The time at which these details were last updated. This update_time is different from the Membership-level update_time since EndpointDetails are updated internally for API consumers. "vcpuCount": 42, # Output only. vCPU count as reported by Kubernetes nodes resources. }, @@ -509,7 +509,7 @@

Method Details

"edgeCluster": { # EdgeCluster contains information specific to Google Edge Clusters. # Optional. Specific information for a Google Edge cluster. "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the Edge Cluster. For example: //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster }, - "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE-on-GCP cluster. + "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE on Google Cloud cluster. "clusterMissing": True or False, # Output only. If cluster_missing is set then it denotes that the GKE cluster no longer exists in the GKE Control Plane. "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the GKE cluster. For example: //container.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster Zonal clusters are also supported. }, @@ -518,7 +518,7 @@

Method Details

"kubernetesApiServerVersion": "A String", # Output only. Kubernetes API server version string as reported by `/version`. "memoryMb": 42, # Output only. The total memory capacity as reported by the sum of all Kubernetes nodes resources, defined in MB. "nodeCount": 42, # Output only. Node count as reported by Kubernetes nodes resources. - "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the node_count will be zero and the node_provider_id will be empty. + "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE on Google Cloud), the node_count will be zero and the node_provider_id will be empty. "updateTime": "A String", # Output only. The time at which these details were last updated. This update_time is different from the Membership-level update_time since EndpointDetails are updated internally for API consumers. "vcpuCount": 42, # Output only. vCPU count as reported by Kubernetes nodes resources. }, @@ -624,7 +624,7 @@

Method Details

"edgeCluster": { # EdgeCluster contains information specific to Google Edge Clusters. # Optional. Specific information for a Google Edge cluster. "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the Edge Cluster. For example: //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster }, - "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE-on-GCP cluster. + "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE on Google Cloud cluster. "clusterMissing": True or False, # Output only. If cluster_missing is set then it denotes that the GKE cluster no longer exists in the GKE Control Plane. "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the GKE cluster. For example: //container.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster Zonal clusters are also supported. }, @@ -633,7 +633,7 @@

Method Details

"kubernetesApiServerVersion": "A String", # Output only. Kubernetes API server version string as reported by `/version`. "memoryMb": 42, # Output only. The total memory capacity as reported by the sum of all Kubernetes nodes resources, defined in MB. "nodeCount": 42, # Output only. Node count as reported by Kubernetes nodes resources. - "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the node_count will be zero and the node_provider_id will be empty. + "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE on Google Cloud), the node_count will be zero and the node_provider_id will be empty. "updateTime": "A String", # Output only. The time at which these details were last updated. This update_time is different from the Membership-level update_time since EndpointDetails are updated internally for API consumers. "vcpuCount": 42, # Output only. vCPU count as reported by Kubernetes nodes resources. }, diff --git a/docs/dyn/gkehub_v1.projects.locations.scopes.html b/docs/dyn/gkehub_v1.projects.locations.scopes.html index 45ad08cd07..e7125e29e7 100644 --- a/docs/dyn/gkehub_v1.projects.locations.scopes.html +++ b/docs/dyn/gkehub_v1.projects.locations.scopes.html @@ -381,7 +381,7 @@

Method Details

"edgeCluster": { # EdgeCluster contains information specific to Google Edge Clusters. # Optional. Specific information for a Google Edge cluster. "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the Edge Cluster. For example: //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster }, - "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE-on-GCP cluster. + "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE on Google Cloud cluster. "clusterMissing": True or False, # Output only. If cluster_missing is set then it denotes that the GKE cluster no longer exists in the GKE Control Plane. "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the GKE cluster. For example: //container.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster Zonal clusters are also supported. }, @@ -390,7 +390,7 @@

Method Details

"kubernetesApiServerVersion": "A String", # Output only. Kubernetes API server version string as reported by `/version`. "memoryMb": 42, # Output only. The total memory capacity as reported by the sum of all Kubernetes nodes resources, defined in MB. "nodeCount": 42, # Output only. Node count as reported by Kubernetes nodes resources. - "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the node_count will be zero and the node_provider_id will be empty. + "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE on Google Cloud), the node_count will be zero and the node_provider_id will be empty. "updateTime": "A String", # Output only. The time at which these details were last updated. This update_time is different from the Membership-level update_time since EndpointDetails are updated internally for API consumers. "vcpuCount": 42, # Output only. vCPU count as reported by Kubernetes nodes resources. }, diff --git a/docs/dyn/gkehub_v1alpha.projects.locations.memberships.html b/docs/dyn/gkehub_v1alpha.projects.locations.memberships.html index 140f7f62a8..4d150659c5 100644 --- a/docs/dyn/gkehub_v1alpha.projects.locations.memberships.html +++ b/docs/dyn/gkehub_v1alpha.projects.locations.memberships.html @@ -167,7 +167,7 @@

Method Details

"edgeCluster": { # EdgeCluster contains information specific to Google Edge Clusters. # Optional. Specific information for a Google Edge cluster. "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the Edge Cluster. For example: //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster }, - "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE-on-GCP cluster. + "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE on Google Cloud cluster. "clusterMissing": True or False, # Output only. If cluster_missing is set then it denotes that the GKE cluster no longer exists in the GKE Control Plane. "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the GKE cluster. For example: //container.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster Zonal clusters are also supported. }, @@ -176,7 +176,7 @@

Method Details

"kubernetesApiServerVersion": "A String", # Output only. Kubernetes API server version string as reported by `/version`. "memoryMb": 42, # Output only. The total memory capacity as reported by the sum of all Kubernetes nodes resources, defined in MB. "nodeCount": 42, # Output only. Node count as reported by Kubernetes nodes resources. - "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the node_count will be zero and the node_provider_id will be empty. + "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE on Google Cloud), the node_count will be zero and the node_provider_id will be empty. "updateTime": "A String", # Output only. The time at which these details were last updated. This update_time is different from the Membership-level update_time since EndpointDetails are updated internally for API consumers. "vcpuCount": 42, # Output only. vCPU count as reported by Kubernetes nodes resources. }, @@ -390,7 +390,7 @@

Method Details

"edgeCluster": { # EdgeCluster contains information specific to Google Edge Clusters. # Optional. Specific information for a Google Edge cluster. "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the Edge Cluster. For example: //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster }, - "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE-on-GCP cluster. + "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE on Google Cloud cluster. "clusterMissing": True or False, # Output only. If cluster_missing is set then it denotes that the GKE cluster no longer exists in the GKE Control Plane. "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the GKE cluster. For example: //container.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster Zonal clusters are also supported. }, @@ -399,7 +399,7 @@

Method Details

"kubernetesApiServerVersion": "A String", # Output only. Kubernetes API server version string as reported by `/version`. "memoryMb": 42, # Output only. The total memory capacity as reported by the sum of all Kubernetes nodes resources, defined in MB. "nodeCount": 42, # Output only. Node count as reported by Kubernetes nodes resources. - "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the node_count will be zero and the node_provider_id will be empty. + "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE on Google Cloud), the node_count will be zero and the node_provider_id will be empty. "updateTime": "A String", # Output only. The time at which these details were last updated. This update_time is different from the Membership-level update_time since EndpointDetails are updated internally for API consumers. "vcpuCount": 42, # Output only. vCPU count as reported by Kubernetes nodes resources. }, @@ -546,7 +546,7 @@

Method Details

"edgeCluster": { # EdgeCluster contains information specific to Google Edge Clusters. # Optional. Specific information for a Google Edge cluster. "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the Edge Cluster. For example: //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster }, - "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE-on-GCP cluster. + "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE on Google Cloud cluster. "clusterMissing": True or False, # Output only. If cluster_missing is set then it denotes that the GKE cluster no longer exists in the GKE Control Plane. "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the GKE cluster. For example: //container.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster Zonal clusters are also supported. }, @@ -555,7 +555,7 @@

Method Details

"kubernetesApiServerVersion": "A String", # Output only. Kubernetes API server version string as reported by `/version`. "memoryMb": 42, # Output only. The total memory capacity as reported by the sum of all Kubernetes nodes resources, defined in MB. "nodeCount": 42, # Output only. Node count as reported by Kubernetes nodes resources. - "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the node_count will be zero and the node_provider_id will be empty. + "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE on Google Cloud), the node_count will be zero and the node_provider_id will be empty. "updateTime": "A String", # Output only. The time at which these details were last updated. This update_time is different from the Membership-level update_time since EndpointDetails are updated internally for API consumers. "vcpuCount": 42, # Output only. vCPU count as reported by Kubernetes nodes resources. }, @@ -658,7 +658,7 @@

Method Details

"edgeCluster": { # EdgeCluster contains information specific to Google Edge Clusters. # Optional. Specific information for a Google Edge cluster. "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the Edge Cluster. For example: //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster }, - "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE-on-GCP cluster. + "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE on Google Cloud cluster. "clusterMissing": True or False, # Output only. If cluster_missing is set then it denotes that the GKE cluster no longer exists in the GKE Control Plane. "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the GKE cluster. For example: //container.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster Zonal clusters are also supported. }, @@ -667,7 +667,7 @@

Method Details

"kubernetesApiServerVersion": "A String", # Output only. Kubernetes API server version string as reported by `/version`. "memoryMb": 42, # Output only. The total memory capacity as reported by the sum of all Kubernetes nodes resources, defined in MB. "nodeCount": 42, # Output only. Node count as reported by Kubernetes nodes resources. - "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the node_count will be zero and the node_provider_id will be empty. + "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE on Google Cloud), the node_count will be zero and the node_provider_id will be empty. "updateTime": "A String", # Output only. The time at which these details were last updated. This update_time is different from the Membership-level update_time since EndpointDetails are updated internally for API consumers. "vcpuCount": 42, # Output only. vCPU count as reported by Kubernetes nodes resources. }, @@ -788,7 +788,7 @@

Method Details

"edgeCluster": { # EdgeCluster contains information specific to Google Edge Clusters. # Optional. Specific information for a Google Edge cluster. "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the Edge Cluster. For example: //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster }, - "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE-on-GCP cluster. + "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE on Google Cloud cluster. "clusterMissing": True or False, # Output only. If cluster_missing is set then it denotes that the GKE cluster no longer exists in the GKE Control Plane. "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the GKE cluster. For example: //container.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster Zonal clusters are also supported. }, @@ -797,7 +797,7 @@

Method Details

"kubernetesApiServerVersion": "A String", # Output only. Kubernetes API server version string as reported by `/version`. "memoryMb": 42, # Output only. The total memory capacity as reported by the sum of all Kubernetes nodes resources, defined in MB. "nodeCount": 42, # Output only. Node count as reported by Kubernetes nodes resources. - "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the node_count will be zero and the node_provider_id will be empty. + "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE on Google Cloud), the node_count will be zero and the node_provider_id will be empty. "updateTime": "A String", # Output only. The time at which these details were last updated. This update_time is different from the Membership-level update_time since EndpointDetails are updated internally for API consumers. "vcpuCount": 42, # Output only. vCPU count as reported by Kubernetes nodes resources. }, @@ -1030,7 +1030,7 @@

Method Details

"edgeCluster": { # EdgeCluster contains information specific to Google Edge Clusters. # Optional. Specific information for a Google Edge cluster. "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the Edge Cluster. For example: //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster }, - "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE-on-GCP cluster. + "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE on Google Cloud cluster. "clusterMissing": True or False, # Output only. If cluster_missing is set then it denotes that the GKE cluster no longer exists in the GKE Control Plane. "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the GKE cluster. For example: //container.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster Zonal clusters are also supported. }, @@ -1039,7 +1039,7 @@

Method Details

"kubernetesApiServerVersion": "A String", # Output only. Kubernetes API server version string as reported by `/version`. "memoryMb": 42, # Output only. The total memory capacity as reported by the sum of all Kubernetes nodes resources, defined in MB. "nodeCount": 42, # Output only. Node count as reported by Kubernetes nodes resources. - "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the node_count will be zero and the node_provider_id will be empty. + "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE on Google Cloud), the node_count will be zero and the node_provider_id will be empty. "updateTime": "A String", # Output only. The time at which these details were last updated. This update_time is different from the Membership-level update_time since EndpointDetails are updated internally for API consumers. "vcpuCount": 42, # Output only. vCPU count as reported by Kubernetes nodes resources. }, diff --git a/docs/dyn/gkehub_v1alpha.projects.locations.scopes.html b/docs/dyn/gkehub_v1alpha.projects.locations.scopes.html index 4d2f10e27c..4206e1eef4 100644 --- a/docs/dyn/gkehub_v1alpha.projects.locations.scopes.html +++ b/docs/dyn/gkehub_v1alpha.projects.locations.scopes.html @@ -381,7 +381,7 @@

Method Details

"edgeCluster": { # EdgeCluster contains information specific to Google Edge Clusters. # Optional. Specific information for a Google Edge cluster. "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the Edge Cluster. For example: //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster }, - "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE-on-GCP cluster. + "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE on Google Cloud cluster. "clusterMissing": True or False, # Output only. If cluster_missing is set then it denotes that the GKE cluster no longer exists in the GKE Control Plane. "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the GKE cluster. For example: //container.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster Zonal clusters are also supported. }, @@ -390,7 +390,7 @@

Method Details

"kubernetesApiServerVersion": "A String", # Output only. Kubernetes API server version string as reported by `/version`. "memoryMb": 42, # Output only. The total memory capacity as reported by the sum of all Kubernetes nodes resources, defined in MB. "nodeCount": 42, # Output only. Node count as reported by Kubernetes nodes resources. - "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the node_count will be zero and the node_provider_id will be empty. + "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE on Google Cloud), the node_count will be zero and the node_provider_id will be empty. "updateTime": "A String", # Output only. The time at which these details were last updated. This update_time is different from the Membership-level update_time since EndpointDetails are updated internally for API consumers. "vcpuCount": 42, # Output only. vCPU count as reported by Kubernetes nodes resources. }, diff --git a/docs/dyn/gkehub_v1beta.projects.locations.memberships.html b/docs/dyn/gkehub_v1beta.projects.locations.memberships.html index 27ab20de0f..6977cc96db 100644 --- a/docs/dyn/gkehub_v1beta.projects.locations.memberships.html +++ b/docs/dyn/gkehub_v1beta.projects.locations.memberships.html @@ -152,7 +152,7 @@

Method Details

"edgeCluster": { # EdgeCluster contains information specific to Google Edge Clusters. # Optional. Specific information for a Google Edge cluster. "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the Edge Cluster. For example: //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster }, - "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE-on-GCP cluster. + "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE on Google Cloud cluster. "clusterMissing": True or False, # Output only. If cluster_missing is set then it denotes that the GKE cluster no longer exists in the GKE Control Plane. "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the GKE cluster. For example: //container.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster Zonal clusters are also supported. }, @@ -161,7 +161,7 @@

Method Details

"kubernetesApiServerVersion": "A String", # Output only. Kubernetes API server version string as reported by `/version`. "memoryMb": 42, # Output only. The total memory capacity as reported by the sum of all Kubernetes nodes resources, defined in MB. "nodeCount": 42, # Output only. Node count as reported by Kubernetes nodes resources. - "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the node_count will be zero and the node_provider_id will be empty. + "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE on Google Cloud), the node_count will be zero and the node_provider_id will be empty. "updateTime": "A String", # Output only. The time at which these details were last updated. This update_time is different from the Membership-level update_time since EndpointDetails are updated internally for API consumers. "vcpuCount": 42, # Output only. vCPU count as reported by Kubernetes nodes resources. }, @@ -353,7 +353,7 @@

Method Details

"edgeCluster": { # EdgeCluster contains information specific to Google Edge Clusters. # Optional. Specific information for a Google Edge cluster. "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the Edge Cluster. For example: //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster }, - "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE-on-GCP cluster. + "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE on Google Cloud cluster. "clusterMissing": True or False, # Output only. If cluster_missing is set then it denotes that the GKE cluster no longer exists in the GKE Control Plane. "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the GKE cluster. For example: //container.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster Zonal clusters are also supported. }, @@ -362,7 +362,7 @@

Method Details

"kubernetesApiServerVersion": "A String", # Output only. Kubernetes API server version string as reported by `/version`. "memoryMb": 42, # Output only. The total memory capacity as reported by the sum of all Kubernetes nodes resources, defined in MB. "nodeCount": 42, # Output only. Node count as reported by Kubernetes nodes resources. - "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the node_count will be zero and the node_provider_id will be empty. + "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE on Google Cloud), the node_count will be zero and the node_provider_id will be empty. "updateTime": "A String", # Output only. The time at which these details were last updated. This update_time is different from the Membership-level update_time since EndpointDetails are updated internally for API consumers. "vcpuCount": 42, # Output only. vCPU count as reported by Kubernetes nodes resources. }, @@ -509,7 +509,7 @@

Method Details

"edgeCluster": { # EdgeCluster contains information specific to Google Edge Clusters. # Optional. Specific information for a Google Edge cluster. "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the Edge Cluster. For example: //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster }, - "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE-on-GCP cluster. + "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE on Google Cloud cluster. "clusterMissing": True or False, # Output only. If cluster_missing is set then it denotes that the GKE cluster no longer exists in the GKE Control Plane. "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the GKE cluster. For example: //container.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster Zonal clusters are also supported. }, @@ -518,7 +518,7 @@

Method Details

"kubernetesApiServerVersion": "A String", # Output only. Kubernetes API server version string as reported by `/version`. "memoryMb": 42, # Output only. The total memory capacity as reported by the sum of all Kubernetes nodes resources, defined in MB. "nodeCount": 42, # Output only. Node count as reported by Kubernetes nodes resources. - "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the node_count will be zero and the node_provider_id will be empty. + "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE on Google Cloud), the node_count will be zero and the node_provider_id will be empty. "updateTime": "A String", # Output only. The time at which these details were last updated. This update_time is different from the Membership-level update_time since EndpointDetails are updated internally for API consumers. "vcpuCount": 42, # Output only. vCPU count as reported by Kubernetes nodes resources. }, @@ -624,7 +624,7 @@

Method Details

"edgeCluster": { # EdgeCluster contains information specific to Google Edge Clusters. # Optional. Specific information for a Google Edge cluster. "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the Edge Cluster. For example: //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster }, - "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE-on-GCP cluster. + "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE on Google Cloud cluster. "clusterMissing": True or False, # Output only. If cluster_missing is set then it denotes that the GKE cluster no longer exists in the GKE Control Plane. "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the GKE cluster. For example: //container.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster Zonal clusters are also supported. }, @@ -633,7 +633,7 @@

Method Details

"kubernetesApiServerVersion": "A String", # Output only. Kubernetes API server version string as reported by `/version`. "memoryMb": 42, # Output only. The total memory capacity as reported by the sum of all Kubernetes nodes resources, defined in MB. "nodeCount": 42, # Output only. Node count as reported by Kubernetes nodes resources. - "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the node_count will be zero and the node_provider_id will be empty. + "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE on Google Cloud), the node_count will be zero and the node_provider_id will be empty. "updateTime": "A String", # Output only. The time at which these details were last updated. This update_time is different from the Membership-level update_time since EndpointDetails are updated internally for API consumers. "vcpuCount": 42, # Output only. vCPU count as reported by Kubernetes nodes resources. }, diff --git a/docs/dyn/gkehub_v1beta.projects.locations.scopes.html b/docs/dyn/gkehub_v1beta.projects.locations.scopes.html index eec71662bf..b89898d24d 100644 --- a/docs/dyn/gkehub_v1beta.projects.locations.scopes.html +++ b/docs/dyn/gkehub_v1beta.projects.locations.scopes.html @@ -381,7 +381,7 @@

Method Details

"edgeCluster": { # EdgeCluster contains information specific to Google Edge Clusters. # Optional. Specific information for a Google Edge cluster. "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the Edge Cluster. For example: //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster }, - "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE-on-GCP cluster. + "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE on Google Cloud cluster. "clusterMissing": True or False, # Output only. If cluster_missing is set then it denotes that the GKE cluster no longer exists in the GKE Control Plane. "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the GKE cluster. For example: //container.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster Zonal clusters are also supported. }, @@ -390,7 +390,7 @@

Method Details

"kubernetesApiServerVersion": "A String", # Output only. Kubernetes API server version string as reported by `/version`. "memoryMb": 42, # Output only. The total memory capacity as reported by the sum of all Kubernetes nodes resources, defined in MB. "nodeCount": 42, # Output only. Node count as reported by Kubernetes nodes resources. - "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the node_count will be zero and the node_provider_id will be empty. + "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE on Google Cloud), the node_count will be zero and the node_provider_id will be empty. "updateTime": "A String", # Output only. The time at which these details were last updated. This update_time is different from the Membership-level update_time since EndpointDetails are updated internally for API consumers. "vcpuCount": 42, # Output only. vCPU count as reported by Kubernetes nodes resources. }, diff --git a/docs/dyn/gkehub_v1beta1.projects.locations.memberships.html b/docs/dyn/gkehub_v1beta1.projects.locations.memberships.html index 0cd9f7132c..9ee8e1a42a 100644 --- a/docs/dyn/gkehub_v1beta1.projects.locations.memberships.html +++ b/docs/dyn/gkehub_v1beta1.projects.locations.memberships.html @@ -142,20 +142,20 @@

Method Details

"description": "A String", # Optional. Description of this membership, limited to 63 characters. Must match the regex: `a-zA-Z0-9*` "endpoint": { # MembershipEndpoint contains information needed to contact a Kubernetes API, endpoint and any additional Kubernetes metadata. # Optional. Endpoint information to reach this member. "applianceCluster": { # ApplianceCluster contains information specific to GDC Edge Appliance Clusters. # Optional. Specific information for a GDC Edge Appliance cluster. - "resourceLink": "A String", # Immutable. Self-link of the GCP resource for the Appliance Cluster. For example: //transferappliance.googleapis.com/projects/my-project/locations/us-west1-a/appliances/my-appliance + "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the Appliance Cluster. For example: //transferappliance.googleapis.com/projects/my-project/locations/us-west1-a/appliances/my-appliance }, "edgeCluster": { # EdgeCluster contains information specific to Google Edge Clusters. # Optional. Specific information for a Google Edge cluster. - "resourceLink": "A String", # Immutable. Self-link of the GCP resource for the Edge Cluster. For example: //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster + "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the Edge Cluster. For example: //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster }, - "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE-on-GCP cluster. + "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE-on-Google Cloud cluster. "clusterMissing": True or False, # Output only. If cluster_missing is set then it denotes that the GKE cluster no longer exists in the GKE Control Plane. - "resourceLink": "A String", # Immutable. Self-link of the GCP resource for the GKE cluster. For example: //container.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster Zonal clusters are also supported. + "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the GKE cluster. For example: //container.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster Zonal clusters are also supported. }, "kubernetesMetadata": { # KubernetesMetadata provides informational metadata for Memberships representing Kubernetes clusters. # Output only. Useful Kubernetes-specific metadata. "kubernetesApiServerVersion": "A String", # Output only. Kubernetes API server version string as reported by '/version'. "memoryMb": 42, # Output only. The total memory capacity as reported by the sum of all Kubernetes nodes resources, defined in MB. "nodeCount": 42, # Output only. Node count as reported by Kubernetes nodes resources. - "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the node_count will be zero and the node_provider_id will be empty. + "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-Google Cloud), the node_count will be zero and the node_provider_id will be empty. "updateTime": "A String", # Output only. The time at which these details were last updated. This update_time is different from the Membership-level update_time since EndpointDetails are updated internally for API consumers. "vcpuCount": 42, # Output only. vCPU count as reported by Kubernetes nodes resources. }, @@ -182,18 +182,18 @@

Method Details

}, "multiCloudCluster": { # MultiCloudCluster contains information specific to GKE Multi-Cloud clusters. # Optional. Specific information for a GKE Multi-Cloud cluster. "clusterMissing": True or False, # Output only. If cluster_missing is set then it denotes that API(gkemulticloud.googleapis.com) resource for this GKE Multi-Cloud cluster no longer exists. - "resourceLink": "A String", # Immutable. Self-link of the GCP resource for the GKE Multi-Cloud cluster. For example: //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/awsClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/azureClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/attachedClusters/my-cluster + "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the GKE Multi-Cloud cluster. For example: //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/awsClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/azureClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/attachedClusters/my-cluster }, "onPremCluster": { # OnPremCluster contains information specific to GKE On-Prem clusters. # Optional. Specific information for a GKE On-Prem cluster. An onprem user-cluster who has no resourceLink is not allowed to use this field, it should have a nil "type" instead. "adminCluster": True or False, # Immutable. Whether the cluster is an admin cluster. "clusterMissing": True or False, # Output only. If cluster_missing is set then it denotes that API(gkeonprem.googleapis.com) resource for this GKE On-Prem cluster no longer exists. "clusterType": "A String", # Immutable. The on prem cluster's type. - "resourceLink": "A String", # Immutable. Self-link of the GCP resource for the GKE On-Prem cluster. For example: //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/vmwareClusters/my-cluster //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/bareMetalClusters/my-cluster + "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the GKE On-Prem cluster. For example: //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/vmwareClusters/my-cluster //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/bareMetalClusters/my-cluster }, }, "externalId": "A String", # Optional. An externally-generated and managed ID for this Membership. This ID may be modified after creation, but this is not recommended. For GKE clusters, external_id is managed by the Hub API and updates will be ignored. The ID must match the regex: `a-zA-Z0-9*` If this Membership represents a Kubernetes cluster, this value should be set to the UID of the `kube-system` namespace object. "infrastructureType": "A String", # Optional. The infrastructure type this Membership is running on. - "labels": { # Optional. GCP labels for this membership. These labels are not leveraged by multi-cluster features, instead, we prefer cluster labels, which can be set on GKE cluster or other cluster types. + "labels": { # Optional. Google Cloud labels for this membership. These labels are not leveraged by multi-cluster features, instead, we prefer cluster labels, which can be set on GKE cluster or other cluster types. "a_key": "A String", }, "lastConnectionTime": "A String", # Output only. For clusters using Connect, the timestamp of the most recent connection established with Google Cloud. This time is updated every several minutes, not continuously. For clusters that do not use GKE Connect, or that have never connected successfully, this field will be unset. @@ -367,20 +367,20 @@

Method Details

"description": "A String", # Optional. Description of this membership, limited to 63 characters. Must match the regex: `a-zA-Z0-9*` "endpoint": { # MembershipEndpoint contains information needed to contact a Kubernetes API, endpoint and any additional Kubernetes metadata. # Optional. Endpoint information to reach this member. "applianceCluster": { # ApplianceCluster contains information specific to GDC Edge Appliance Clusters. # Optional. Specific information for a GDC Edge Appliance cluster. - "resourceLink": "A String", # Immutable. Self-link of the GCP resource for the Appliance Cluster. For example: //transferappliance.googleapis.com/projects/my-project/locations/us-west1-a/appliances/my-appliance + "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the Appliance Cluster. For example: //transferappliance.googleapis.com/projects/my-project/locations/us-west1-a/appliances/my-appliance }, "edgeCluster": { # EdgeCluster contains information specific to Google Edge Clusters. # Optional. Specific information for a Google Edge cluster. - "resourceLink": "A String", # Immutable. Self-link of the GCP resource for the Edge Cluster. For example: //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster + "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the Edge Cluster. For example: //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster }, - "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE-on-GCP cluster. + "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE-on-Google Cloud cluster. "clusterMissing": True or False, # Output only. If cluster_missing is set then it denotes that the GKE cluster no longer exists in the GKE Control Plane. - "resourceLink": "A String", # Immutable. Self-link of the GCP resource for the GKE cluster. For example: //container.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster Zonal clusters are also supported. + "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the GKE cluster. For example: //container.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster Zonal clusters are also supported. }, "kubernetesMetadata": { # KubernetesMetadata provides informational metadata for Memberships representing Kubernetes clusters. # Output only. Useful Kubernetes-specific metadata. "kubernetesApiServerVersion": "A String", # Output only. Kubernetes API server version string as reported by '/version'. "memoryMb": 42, # Output only. The total memory capacity as reported by the sum of all Kubernetes nodes resources, defined in MB. "nodeCount": 42, # Output only. Node count as reported by Kubernetes nodes resources. - "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the node_count will be zero and the node_provider_id will be empty. + "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-Google Cloud), the node_count will be zero and the node_provider_id will be empty. "updateTime": "A String", # Output only. The time at which these details were last updated. This update_time is different from the Membership-level update_time since EndpointDetails are updated internally for API consumers. "vcpuCount": 42, # Output only. vCPU count as reported by Kubernetes nodes resources. }, @@ -407,18 +407,18 @@

Method Details

}, "multiCloudCluster": { # MultiCloudCluster contains information specific to GKE Multi-Cloud clusters. # Optional. Specific information for a GKE Multi-Cloud cluster. "clusterMissing": True or False, # Output only. If cluster_missing is set then it denotes that API(gkemulticloud.googleapis.com) resource for this GKE Multi-Cloud cluster no longer exists. - "resourceLink": "A String", # Immutable. Self-link of the GCP resource for the GKE Multi-Cloud cluster. For example: //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/awsClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/azureClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/attachedClusters/my-cluster + "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the GKE Multi-Cloud cluster. For example: //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/awsClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/azureClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/attachedClusters/my-cluster }, "onPremCluster": { # OnPremCluster contains information specific to GKE On-Prem clusters. # Optional. Specific information for a GKE On-Prem cluster. An onprem user-cluster who has no resourceLink is not allowed to use this field, it should have a nil "type" instead. "adminCluster": True or False, # Immutable. Whether the cluster is an admin cluster. "clusterMissing": True or False, # Output only. If cluster_missing is set then it denotes that API(gkeonprem.googleapis.com) resource for this GKE On-Prem cluster no longer exists. "clusterType": "A String", # Immutable. The on prem cluster's type. - "resourceLink": "A String", # Immutable. Self-link of the GCP resource for the GKE On-Prem cluster. For example: //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/vmwareClusters/my-cluster //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/bareMetalClusters/my-cluster + "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the GKE On-Prem cluster. For example: //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/vmwareClusters/my-cluster //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/bareMetalClusters/my-cluster }, }, "externalId": "A String", # Optional. An externally-generated and managed ID for this Membership. This ID may be modified after creation, but this is not recommended. For GKE clusters, external_id is managed by the Hub API and updates will be ignored. The ID must match the regex: `a-zA-Z0-9*` If this Membership represents a Kubernetes cluster, this value should be set to the UID of the `kube-system` namespace object. "infrastructureType": "A String", # Optional. The infrastructure type this Membership is running on. - "labels": { # Optional. GCP labels for this membership. These labels are not leveraged by multi-cluster features, instead, we prefer cluster labels, which can be set on GKE cluster or other cluster types. + "labels": { # Optional. Google Cloud labels for this membership. These labels are not leveraged by multi-cluster features, instead, we prefer cluster labels, which can be set on GKE cluster or other cluster types. "a_key": "A String", }, "lastConnectionTime": "A String", # Output only. For clusters using Connect, the timestamp of the most recent connection established with Google Cloud. This time is updated every several minutes, not continuously. For clusters that do not use GKE Connect, or that have never connected successfully, this field will be unset. @@ -524,20 +524,20 @@

Method Details

"description": "A String", # Optional. Description of this membership, limited to 63 characters. Must match the regex: `a-zA-Z0-9*` "endpoint": { # MembershipEndpoint contains information needed to contact a Kubernetes API, endpoint and any additional Kubernetes metadata. # Optional. Endpoint information to reach this member. "applianceCluster": { # ApplianceCluster contains information specific to GDC Edge Appliance Clusters. # Optional. Specific information for a GDC Edge Appliance cluster. - "resourceLink": "A String", # Immutable. Self-link of the GCP resource for the Appliance Cluster. For example: //transferappliance.googleapis.com/projects/my-project/locations/us-west1-a/appliances/my-appliance + "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the Appliance Cluster. For example: //transferappliance.googleapis.com/projects/my-project/locations/us-west1-a/appliances/my-appliance }, "edgeCluster": { # EdgeCluster contains information specific to Google Edge Clusters. # Optional. Specific information for a Google Edge cluster. - "resourceLink": "A String", # Immutable. Self-link of the GCP resource for the Edge Cluster. For example: //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster + "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the Edge Cluster. For example: //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster }, - "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE-on-GCP cluster. + "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE-on-Google Cloud cluster. "clusterMissing": True or False, # Output only. If cluster_missing is set then it denotes that the GKE cluster no longer exists in the GKE Control Plane. - "resourceLink": "A String", # Immutable. Self-link of the GCP resource for the GKE cluster. For example: //container.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster Zonal clusters are also supported. + "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the GKE cluster. For example: //container.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster Zonal clusters are also supported. }, "kubernetesMetadata": { # KubernetesMetadata provides informational metadata for Memberships representing Kubernetes clusters. # Output only. Useful Kubernetes-specific metadata. "kubernetesApiServerVersion": "A String", # Output only. Kubernetes API server version string as reported by '/version'. "memoryMb": 42, # Output only. The total memory capacity as reported by the sum of all Kubernetes nodes resources, defined in MB. "nodeCount": 42, # Output only. Node count as reported by Kubernetes nodes resources. - "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the node_count will be zero and the node_provider_id will be empty. + "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-Google Cloud), the node_count will be zero and the node_provider_id will be empty. "updateTime": "A String", # Output only. The time at which these details were last updated. This update_time is different from the Membership-level update_time since EndpointDetails are updated internally for API consumers. "vcpuCount": 42, # Output only. vCPU count as reported by Kubernetes nodes resources. }, @@ -564,18 +564,18 @@

Method Details

}, "multiCloudCluster": { # MultiCloudCluster contains information specific to GKE Multi-Cloud clusters. # Optional. Specific information for a GKE Multi-Cloud cluster. "clusterMissing": True or False, # Output only. If cluster_missing is set then it denotes that API(gkemulticloud.googleapis.com) resource for this GKE Multi-Cloud cluster no longer exists. - "resourceLink": "A String", # Immutable. Self-link of the GCP resource for the GKE Multi-Cloud cluster. For example: //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/awsClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/azureClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/attachedClusters/my-cluster + "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the GKE Multi-Cloud cluster. For example: //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/awsClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/azureClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/attachedClusters/my-cluster }, "onPremCluster": { # OnPremCluster contains information specific to GKE On-Prem clusters. # Optional. Specific information for a GKE On-Prem cluster. An onprem user-cluster who has no resourceLink is not allowed to use this field, it should have a nil "type" instead. "adminCluster": True or False, # Immutable. Whether the cluster is an admin cluster. "clusterMissing": True or False, # Output only. If cluster_missing is set then it denotes that API(gkeonprem.googleapis.com) resource for this GKE On-Prem cluster no longer exists. "clusterType": "A String", # Immutable. The on prem cluster's type. - "resourceLink": "A String", # Immutable. Self-link of the GCP resource for the GKE On-Prem cluster. For example: //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/vmwareClusters/my-cluster //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/bareMetalClusters/my-cluster + "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the GKE On-Prem cluster. For example: //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/vmwareClusters/my-cluster //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/bareMetalClusters/my-cluster }, }, "externalId": "A String", # Optional. An externally-generated and managed ID for this Membership. This ID may be modified after creation, but this is not recommended. For GKE clusters, external_id is managed by the Hub API and updates will be ignored. The ID must match the regex: `a-zA-Z0-9*` If this Membership represents a Kubernetes cluster, this value should be set to the UID of the `kube-system` namespace object. "infrastructureType": "A String", # Optional. The infrastructure type this Membership is running on. - "labels": { # Optional. GCP labels for this membership. These labels are not leveraged by multi-cluster features, instead, we prefer cluster labels, which can be set on GKE cluster or other cluster types. + "labels": { # Optional. Google Cloud labels for this membership. These labels are not leveraged by multi-cluster features, instead, we prefer cluster labels, which can be set on GKE cluster or other cluster types. "a_key": "A String", }, "lastConnectionTime": "A String", # Output only. For clusters using Connect, the timestamp of the most recent connection established with Google Cloud. This time is updated every several minutes, not continuously. For clusters that do not use GKE Connect, or that have never connected successfully, this field will be unset. @@ -640,20 +640,20 @@

Method Details

"description": "A String", # Optional. Description of this membership, limited to 63 characters. Must match the regex: `a-zA-Z0-9*` "endpoint": { # MembershipEndpoint contains information needed to contact a Kubernetes API, endpoint and any additional Kubernetes metadata. # Optional. Endpoint information to reach this member. "applianceCluster": { # ApplianceCluster contains information specific to GDC Edge Appliance Clusters. # Optional. Specific information for a GDC Edge Appliance cluster. - "resourceLink": "A String", # Immutable. Self-link of the GCP resource for the Appliance Cluster. For example: //transferappliance.googleapis.com/projects/my-project/locations/us-west1-a/appliances/my-appliance + "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the Appliance Cluster. For example: //transferappliance.googleapis.com/projects/my-project/locations/us-west1-a/appliances/my-appliance }, "edgeCluster": { # EdgeCluster contains information specific to Google Edge Clusters. # Optional. Specific information for a Google Edge cluster. - "resourceLink": "A String", # Immutable. Self-link of the GCP resource for the Edge Cluster. For example: //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster + "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the Edge Cluster. For example: //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster }, - "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE-on-GCP cluster. + "gkeCluster": { # GkeCluster contains information specific to GKE clusters. # Optional. Specific information for a GKE-on-Google Cloud cluster. "clusterMissing": True or False, # Output only. If cluster_missing is set then it denotes that the GKE cluster no longer exists in the GKE Control Plane. - "resourceLink": "A String", # Immutable. Self-link of the GCP resource for the GKE cluster. For example: //container.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster Zonal clusters are also supported. + "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the GKE cluster. For example: //container.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster Zonal clusters are also supported. }, "kubernetesMetadata": { # KubernetesMetadata provides informational metadata for Memberships representing Kubernetes clusters. # Output only. Useful Kubernetes-specific metadata. "kubernetesApiServerVersion": "A String", # Output only. Kubernetes API server version string as reported by '/version'. "memoryMb": 42, # Output only. The total memory capacity as reported by the sum of all Kubernetes nodes resources, defined in MB. "nodeCount": 42, # Output only. Node count as reported by Kubernetes nodes resources. - "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the node_count will be zero and the node_provider_id will be empty. + "nodeProviderId": "A String", # Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-Google Cloud), the node_count will be zero and the node_provider_id will be empty. "updateTime": "A String", # Output only. The time at which these details were last updated. This update_time is different from the Membership-level update_time since EndpointDetails are updated internally for API consumers. "vcpuCount": 42, # Output only. vCPU count as reported by Kubernetes nodes resources. }, @@ -680,18 +680,18 @@

Method Details

}, "multiCloudCluster": { # MultiCloudCluster contains information specific to GKE Multi-Cloud clusters. # Optional. Specific information for a GKE Multi-Cloud cluster. "clusterMissing": True or False, # Output only. If cluster_missing is set then it denotes that API(gkemulticloud.googleapis.com) resource for this GKE Multi-Cloud cluster no longer exists. - "resourceLink": "A String", # Immutable. Self-link of the GCP resource for the GKE Multi-Cloud cluster. For example: //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/awsClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/azureClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/attachedClusters/my-cluster + "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the GKE Multi-Cloud cluster. For example: //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/awsClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/azureClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/attachedClusters/my-cluster }, "onPremCluster": { # OnPremCluster contains information specific to GKE On-Prem clusters. # Optional. Specific information for a GKE On-Prem cluster. An onprem user-cluster who has no resourceLink is not allowed to use this field, it should have a nil "type" instead. "adminCluster": True or False, # Immutable. Whether the cluster is an admin cluster. "clusterMissing": True or False, # Output only. If cluster_missing is set then it denotes that API(gkeonprem.googleapis.com) resource for this GKE On-Prem cluster no longer exists. "clusterType": "A String", # Immutable. The on prem cluster's type. - "resourceLink": "A String", # Immutable. Self-link of the GCP resource for the GKE On-Prem cluster. For example: //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/vmwareClusters/my-cluster //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/bareMetalClusters/my-cluster + "resourceLink": "A String", # Immutable. Self-link of the Google Cloud resource for the GKE On-Prem cluster. For example: //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/vmwareClusters/my-cluster //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/bareMetalClusters/my-cluster }, }, "externalId": "A String", # Optional. An externally-generated and managed ID for this Membership. This ID may be modified after creation, but this is not recommended. For GKE clusters, external_id is managed by the Hub API and updates will be ignored. The ID must match the regex: `a-zA-Z0-9*` If this Membership represents a Kubernetes cluster, this value should be set to the UID of the `kube-system` namespace object. "infrastructureType": "A String", # Optional. The infrastructure type this Membership is running on. - "labels": { # Optional. GCP labels for this membership. These labels are not leveraged by multi-cluster features, instead, we prefer cluster labels, which can be set on GKE cluster or other cluster types. + "labels": { # Optional. Google Cloud labels for this membership. These labels are not leveraged by multi-cluster features, instead, we prefer cluster labels, which can be set on GKE cluster or other cluster types. "a_key": "A String", }, "lastConnectionTime": "A String", # Output only. For clusters using Connect, the timestamp of the most recent connection established with Google Cloud. This time is updated every several minutes, not continuously. For clusters that do not use GKE Connect, or that have never connected successfully, this field will be unset. diff --git a/docs/dyn/gkehub_v2.projects.locations.memberships.features.html b/docs/dyn/gkehub_v2.projects.locations.memberships.features.html index 2ce061fcd8..938b572f35 100644 --- a/docs/dyn/gkehub_v2.projects.locations.memberships.features.html +++ b/docs/dyn/gkehub_v2.projects.locations.memberships.features.html @@ -113,7 +113,7 @@

Method Details

{ # MembershipFeature represents the settings and status of a Fleet Feature enabled on a single Fleet Membership. "createTime": "A String", # Output only. When the MembershipFeature resource was created. "deleteTime": "A String", # Output only. When the MembershipFeature resource was deleted. - "labels": { # GCP labels for this MembershipFeature. + "labels": { # Google Cloud labels for this MembershipFeature. "a_key": "A String", }, "lifecycleState": { # LifecycleState describes the state of a MembershipFeature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the MembershipFeature. # Output only. Lifecycle information of the resource itself. @@ -821,7 +821,7 @@

Method Details

{ # MembershipFeature represents the settings and status of a Fleet Feature enabled on a single Fleet Membership. "createTime": "A String", # Output only. When the MembershipFeature resource was created. "deleteTime": "A String", # Output only. When the MembershipFeature resource was deleted. - "labels": { # GCP labels for this MembershipFeature. + "labels": { # Google Cloud labels for this MembershipFeature. "a_key": "A String", }, "lifecycleState": { # LifecycleState describes the state of a MembershipFeature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the MembershipFeature. # Output only. Lifecycle information of the resource itself. @@ -1469,7 +1469,7 @@

Method Details

{ # MembershipFeature represents the settings and status of a Fleet Feature enabled on a single Fleet Membership. "createTime": "A String", # Output only. When the MembershipFeature resource was created. "deleteTime": "A String", # Output only. When the MembershipFeature resource was deleted. - "labels": { # GCP labels for this MembershipFeature. + "labels": { # Google Cloud labels for this MembershipFeature. "a_key": "A String", }, "lifecycleState": { # LifecycleState describes the state of a MembershipFeature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the MembershipFeature. # Output only. Lifecycle information of the resource itself. @@ -2126,7 +2126,7 @@

Method Details

{ # MembershipFeature represents the settings and status of a Fleet Feature enabled on a single Fleet Membership. "createTime": "A String", # Output only. When the MembershipFeature resource was created. "deleteTime": "A String", # Output only. When the MembershipFeature resource was deleted. - "labels": { # GCP labels for this MembershipFeature. + "labels": { # Google Cloud labels for this MembershipFeature. "a_key": "A String", }, "lifecycleState": { # LifecycleState describes the state of a MembershipFeature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the MembershipFeature. # Output only. Lifecycle information of the resource itself. diff --git a/docs/dyn/gkehub_v2alpha.projects.locations.memberships.features.html b/docs/dyn/gkehub_v2alpha.projects.locations.memberships.features.html index aca138a9d0..4ea11eee4d 100644 --- a/docs/dyn/gkehub_v2alpha.projects.locations.memberships.features.html +++ b/docs/dyn/gkehub_v2alpha.projects.locations.memberships.features.html @@ -113,7 +113,7 @@

Method Details

{ # MembershipFeature represents the settings and status of a Fleet Feature enabled on a single Fleet Membership. "createTime": "A String", # Output only. When the MembershipFeature resource was created. "deleteTime": "A String", # Output only. When the MembershipFeature resource was deleted. - "labels": { # GCP labels for this MembershipFeature. + "labels": { # Google Cloud labels for this MembershipFeature. "a_key": "A String", }, "lifecycleState": { # LifecycleState describes the state of a MembershipFeature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the MembershipFeature. # Output only. Lifecycle information of the resource itself. @@ -821,7 +821,7 @@

Method Details

{ # MembershipFeature represents the settings and status of a Fleet Feature enabled on a single Fleet Membership. "createTime": "A String", # Output only. When the MembershipFeature resource was created. "deleteTime": "A String", # Output only. When the MembershipFeature resource was deleted. - "labels": { # GCP labels for this MembershipFeature. + "labels": { # Google Cloud labels for this MembershipFeature. "a_key": "A String", }, "lifecycleState": { # LifecycleState describes the state of a MembershipFeature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the MembershipFeature. # Output only. Lifecycle information of the resource itself. @@ -1469,7 +1469,7 @@

Method Details

{ # MembershipFeature represents the settings and status of a Fleet Feature enabled on a single Fleet Membership. "createTime": "A String", # Output only. When the MembershipFeature resource was created. "deleteTime": "A String", # Output only. When the MembershipFeature resource was deleted. - "labels": { # GCP labels for this MembershipFeature. + "labels": { # Google Cloud labels for this MembershipFeature. "a_key": "A String", }, "lifecycleState": { # LifecycleState describes the state of a MembershipFeature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the MembershipFeature. # Output only. Lifecycle information of the resource itself. @@ -2126,7 +2126,7 @@

Method Details

{ # MembershipFeature represents the settings and status of a Fleet Feature enabled on a single Fleet Membership. "createTime": "A String", # Output only. When the MembershipFeature resource was created. "deleteTime": "A String", # Output only. When the MembershipFeature resource was deleted. - "labels": { # GCP labels for this MembershipFeature. + "labels": { # Google Cloud labels for this MembershipFeature. "a_key": "A String", }, "lifecycleState": { # LifecycleState describes the state of a MembershipFeature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the MembershipFeature. # Output only. Lifecycle information of the resource itself. diff --git a/docs/dyn/gkehub_v2beta.projects.locations.memberships.features.html b/docs/dyn/gkehub_v2beta.projects.locations.memberships.features.html index d0f7e9ab5a..c011cefceb 100644 --- a/docs/dyn/gkehub_v2beta.projects.locations.memberships.features.html +++ b/docs/dyn/gkehub_v2beta.projects.locations.memberships.features.html @@ -113,7 +113,7 @@

Method Details

{ # MembershipFeature represents the settings and status of a Fleet Feature enabled on a single Fleet Membership. "createTime": "A String", # Output only. When the MembershipFeature resource was created. "deleteTime": "A String", # Output only. When the MembershipFeature resource was deleted. - "labels": { # GCP labels for this MembershipFeature. + "labels": { # Google Cloud labels for this MembershipFeature. "a_key": "A String", }, "lifecycleState": { # LifecycleState describes the state of a MembershipFeature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the MembershipFeature. # Output only. Lifecycle information of the resource itself. @@ -821,7 +821,7 @@

Method Details

{ # MembershipFeature represents the settings and status of a Fleet Feature enabled on a single Fleet Membership. "createTime": "A String", # Output only. When the MembershipFeature resource was created. "deleteTime": "A String", # Output only. When the MembershipFeature resource was deleted. - "labels": { # GCP labels for this MembershipFeature. + "labels": { # Google Cloud labels for this MembershipFeature. "a_key": "A String", }, "lifecycleState": { # LifecycleState describes the state of a MembershipFeature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the MembershipFeature. # Output only. Lifecycle information of the resource itself. @@ -1469,7 +1469,7 @@

Method Details

{ # MembershipFeature represents the settings and status of a Fleet Feature enabled on a single Fleet Membership. "createTime": "A String", # Output only. When the MembershipFeature resource was created. "deleteTime": "A String", # Output only. When the MembershipFeature resource was deleted. - "labels": { # GCP labels for this MembershipFeature. + "labels": { # Google Cloud labels for this MembershipFeature. "a_key": "A String", }, "lifecycleState": { # LifecycleState describes the state of a MembershipFeature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the MembershipFeature. # Output only. Lifecycle information of the resource itself. @@ -2126,7 +2126,7 @@

Method Details

{ # MembershipFeature represents the settings and status of a Fleet Feature enabled on a single Fleet Membership. "createTime": "A String", # Output only. When the MembershipFeature resource was created. "deleteTime": "A String", # Output only. When the MembershipFeature resource was deleted. - "labels": { # GCP labels for this MembershipFeature. + "labels": { # Google Cloud labels for this MembershipFeature. "a_key": "A String", }, "lifecycleState": { # LifecycleState describes the state of a MembershipFeature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the MembershipFeature. # Output only. Lifecycle information of the resource itself. diff --git a/docs/dyn/gkeonprem_v1.projects.locations.html b/docs/dyn/gkeonprem_v1.projects.locations.html index 77d2d02c1e..d42320d4a7 100644 --- a/docs/dyn/gkeonprem_v1.projects.locations.html +++ b/docs/dyn/gkeonprem_v1.projects.locations.html @@ -107,7 +107,7 @@

Instance Methods

Gets information about a location.

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

-

Lists information about the supported locations for this service.

+

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

list_next()

Retrieves the next page of results.

@@ -146,7 +146,7 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service.
+  
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/marketingplatformadmin_v1alpha.organizations.html b/docs/dyn/marketingplatformadmin_v1alpha.organizations.html
index 382edba0d9..3cdda7f343 100644
--- a/docs/dyn/marketingplatformadmin_v1alpha.organizations.html
+++ b/docs/dyn/marketingplatformadmin_v1alpha.organizations.html
@@ -87,7 +87,7 @@ 

Instance Methods

Returns a list of clients managed by the sales partner organization. User needs to be an OrgAdmin/BillingAdmin on the sales partner organization in order to view the end clients.

get(name, x__xgafv=None)

-

Lookup for a single organization.

+

Looks up a single organization.

list(pageSize=None, pageToken=None, x__xgafv=None)

Returns a list of organizations that the user has access to.

@@ -96,7 +96,7 @@

Instance Methods

Retrieves the next page of results.

reportPropertyUsage(organization, body=None, x__xgafv=None)

-

Get the usage and billing data for properties within the organization for the specified month. Per direct client org, user needs to be OrgAdmin/BillingAdmin on the organization in order to view the billing and usage data. Per sales partner client org, user needs to be OrgAdmin/BillingAdmin on the sales partner org in order to view the billing and usage data, or OrgAdmin/BillingAdmin on the sales partner client org in order to view the usage data only.

+

Gets the usage and billing data for properties within the organization for the specified month. Per direct client org, user needs to be OrgAdmin/BillingAdmin on the organization in order to view the billing and usage data. Per sales partner client org, user needs to be OrgAdmin/BillingAdmin on the sales partner org in order to view the billing and usage data, or OrgAdmin/BillingAdmin on the sales partner client org in order to view the usage data only.

Method Details

close() @@ -148,7 +148,7 @@

Method Details

get(name, x__xgafv=None) -
Lookup for a single organization.
+  
Looks up a single organization.
 
 Args:
   name: string, Required. The name of the Organization to retrieve. Format: organizations/{org_id} (required)
@@ -208,7 +208,7 @@ 

Method Details

reportPropertyUsage(organization, body=None, x__xgafv=None) -
Get the usage and billing data for properties within the organization for the specified month. Per direct client org, user needs to be OrgAdmin/BillingAdmin on the organization in order to view the billing and usage data. Per sales partner client org, user needs to be OrgAdmin/BillingAdmin on the sales partner org in order to view the billing and usage data, or OrgAdmin/BillingAdmin on the sales partner client org in order to view the usage data only.
+  
Gets the usage and billing data for properties within the organization for the specified month. Per direct client org, user needs to be OrgAdmin/BillingAdmin on the organization in order to view the billing and usage data. Per sales partner client org, user needs to be OrgAdmin/BillingAdmin on the sales partner org in order to view the billing and usage data, or OrgAdmin/BillingAdmin on the sales partner client org in order to view the usage data only.
 
 Args:
   organization: string, Required. Specifies the organization whose property usage will be listed. Format: organizations/{org_id} (required)
diff --git a/docs/dyn/orgpolicy_v2.organizations.customConstraints.html b/docs/dyn/orgpolicy_v2.organizations.customConstraints.html
index 5dc41e842f..1328883862 100644
--- a/docs/dyn/orgpolicy_v2.organizations.customConstraints.html
+++ b/docs/dyn/orgpolicy_v2.organizations.customConstraints.html
@@ -118,7 +118,7 @@ 

Method Details

"methodTypes": [ # All the operations being applied for this constraint. "A String", ], - "name": "A String", # Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 70 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/` is not counted. + "name": "A String", # Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 71 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/custom.` is not counted. "resourceTypes": [ # Immutable. The resource instance type on which this policy applies. Format will be of the form : `/` Example: * `compute.googleapis.com/Instance`. "A String", ], @@ -141,7 +141,7 @@

Method Details

"methodTypes": [ # All the operations being applied for this constraint. "A String", ], - "name": "A String", # Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 70 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/` is not counted. + "name": "A String", # Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 71 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/custom.` is not counted. "resourceTypes": [ # Immutable. The resource instance type on which this policy applies. Format will be of the form : `/` Example: * `compute.googleapis.com/Instance`. "A String", ], @@ -189,7 +189,7 @@

Method Details

"methodTypes": [ # All the operations being applied for this constraint. "A String", ], - "name": "A String", # Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 70 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/` is not counted. + "name": "A String", # Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 71 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/custom.` is not counted. "resourceTypes": [ # Immutable. The resource instance type on which this policy applies. Format will be of the form : `/` Example: * `compute.googleapis.com/Instance`. "A String", ], @@ -223,7 +223,7 @@

Method Details

"methodTypes": [ # All the operations being applied for this constraint. "A String", ], - "name": "A String", # Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 70 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/` is not counted. + "name": "A String", # Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 71 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/custom.` is not counted. "resourceTypes": [ # Immutable. The resource instance type on which this policy applies. Format will be of the form : `/` Example: * `compute.googleapis.com/Instance`. "A String", ], @@ -253,7 +253,7 @@

Method Details

Updates a custom constraint. Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the constraint does not exist. Note: the supplied policy will perform a full overwrite of all fields.
 
 Args:
-  name: string, Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 70 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/` is not counted. (required)
+  name: string, Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 71 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/custom.` is not counted. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -265,7 +265,7 @@ 

Method Details

"methodTypes": [ # All the operations being applied for this constraint. "A String", ], - "name": "A String", # Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 70 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/` is not counted. + "name": "A String", # Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 71 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/custom.` is not counted. "resourceTypes": [ # Immutable. The resource instance type on which this policy applies. Format will be of the form : `/` Example: * `compute.googleapis.com/Instance`. "A String", ], @@ -288,7 +288,7 @@

Method Details

"methodTypes": [ # All the operations being applied for this constraint. "A String", ], - "name": "A String", # Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 70 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/` is not counted. + "name": "A String", # Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 71 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/custom.` is not counted. "resourceTypes": [ # Immutable. The resource instance type on which this policy applies. Format will be of the form : `/` Example: * `compute.googleapis.com/Instance`. "A String", ], diff --git a/docs/dyn/paymentsresellersubscription_v1.partners.subscriptions.html b/docs/dyn/paymentsresellersubscription_v1.partners.subscriptions.html index 844e363d1b..7467b9a070 100644 --- a/docs/dyn/paymentsresellersubscription_v1.partners.subscriptions.html +++ b/docs/dyn/paymentsresellersubscription_v1.partners.subscriptions.html @@ -133,7 +133,7 @@

Method Details

An object of the form: { # Response that contains the cancelled subscription resource. - "subscription": { # A subscription serves as a central billing entity between an external partner and Google. The underlying Google services rely on the subscription state to grant or revoke the user's service entitlement. It's important to note that the subscription state may not always perfectly align with the user's service entitlement. For example, some Google services may continue providing access to the user until the current billing cycle ends, even if the subscription has been immediately canceled. However, other services may not do the same. To fully understand the specific details, please consult the relevant contract or product policy. # The cancelled subscription resource. + "subscription": { # Acts as a central billing entity between an external partner and Google. Google services use the subscription state to grant or revoke the user's service entitlement. Note: The subscription state might not perfectly align with the user's service entitlement. Some services might continue providing access until the current cycle ends, even if the subscription is immediately canceled. Consult the relevant contract or product policy for specific details. # The cancelled subscription resource. "cancellationDetails": { # Describes the details of a cancelled or cancelling subscription. # Output only. Describes the details of a cancelled subscription. Only applicable to subscription of state `STATE_CANCELLED`. "reason": "A String", # Output only. The reason of the cancellation. }, @@ -284,7 +284,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # A subscription serves as a central billing entity between an external partner and Google. The underlying Google services rely on the subscription state to grant or revoke the user's service entitlement. It's important to note that the subscription state may not always perfectly align with the user's service entitlement. For example, some Google services may continue providing access to the user until the current billing cycle ends, even if the subscription has been immediately canceled. However, other services may not do the same. To fully understand the specific details, please consult the relevant contract or product policy. +{ # Acts as a central billing entity between an external partner and Google. Google services use the subscription state to grant or revoke the user's service entitlement. Note: The subscription state might not perfectly align with the user's service entitlement. Some services might continue providing access until the current cycle ends, even if the subscription is immediately canceled. Consult the relevant contract or product policy for specific details. "cancellationDetails": { # Describes the details of a cancelled or cancelling subscription. # Output only. Describes the details of a cancelled subscription. Only applicable to subscription of state `STATE_CANCELLED`. "reason": "A String", # Output only. The reason of the cancellation. }, @@ -428,7 +428,7 @@

Method Details

Returns: An object of the form: - { # A subscription serves as a central billing entity between an external partner and Google. The underlying Google services rely on the subscription state to grant or revoke the user's service entitlement. It's important to note that the subscription state may not always perfectly align with the user's service entitlement. For example, some Google services may continue providing access to the user until the current billing cycle ends, even if the subscription has been immediately canceled. However, other services may not do the same. To fully understand the specific details, please consult the relevant contract or product policy. + { # Acts as a central billing entity between an external partner and Google. Google services use the subscription state to grant or revoke the user's service entitlement. Note: The subscription state might not perfectly align with the user's service entitlement. Some services might continue providing access until the current cycle ends, even if the subscription is immediately canceled. Consult the relevant contract or product policy for specific details. "cancellationDetails": { # Describes the details of a cancelled or cancelling subscription. # Output only. Describes the details of a cancelled subscription. Only applicable to subscription of state `STATE_CANCELLED`. "reason": "A String", # Output only. The reason of the cancellation. }, @@ -593,7 +593,7 @@

Method Details

An object of the form: { # Response that contains the entitled subscription resource. - "subscription": { # A subscription serves as a central billing entity between an external partner and Google. The underlying Google services rely on the subscription state to grant or revoke the user's service entitlement. It's important to note that the subscription state may not always perfectly align with the user's service entitlement. For example, some Google services may continue providing access to the user until the current billing cycle ends, even if the subscription has been immediately canceled. However, other services may not do the same. To fully understand the specific details, please consult the relevant contract or product policy. # The subscription that has user linked to it. + "subscription": { # Acts as a central billing entity between an external partner and Google. Google services use the subscription state to grant or revoke the user's service entitlement. Note: The subscription state might not perfectly align with the user's service entitlement. Some services might continue providing access until the current cycle ends, even if the subscription is immediately canceled. Consult the relevant contract or product policy for specific details. # The subscription that has user linked to it. "cancellationDetails": { # Describes the details of a cancelled or cancelling subscription. # Output only. Describes the details of a cancelled subscription. Only applicable to subscription of state `STATE_CANCELLED`. "reason": "A String", # Output only. The reason of the cancellation. }, @@ -779,7 +779,7 @@

Method Details

Returns: An object of the form: - { # A subscription serves as a central billing entity between an external partner and Google. The underlying Google services rely on the subscription state to grant or revoke the user's service entitlement. It's important to note that the subscription state may not always perfectly align with the user's service entitlement. For example, some Google services may continue providing access to the user until the current billing cycle ends, even if the subscription has been immediately canceled. However, other services may not do the same. To fully understand the specific details, please consult the relevant contract or product policy. + { # Acts as a central billing entity between an external partner and Google. Google services use the subscription state to grant or revoke the user's service entitlement. Note: The subscription state might not perfectly align with the user's service entitlement. Some services might continue providing access until the current cycle ends, even if the subscription is immediately canceled. Consult the relevant contract or product policy for specific details. "cancellationDetails": { # Describes the details of a cancelled or cancelling subscription. # Output only. Describes the details of a cancelled subscription. Only applicable to subscription of state `STATE_CANCELLED`. "reason": "A String", # Output only. The reason of the cancellation. }, @@ -924,7 +924,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # A subscription serves as a central billing entity between an external partner and Google. The underlying Google services rely on the subscription state to grant or revoke the user's service entitlement. It's important to note that the subscription state may not always perfectly align with the user's service entitlement. For example, some Google services may continue providing access to the user until the current billing cycle ends, even if the subscription has been immediately canceled. However, other services may not do the same. To fully understand the specific details, please consult the relevant contract or product policy. +{ # Acts as a central billing entity between an external partner and Google. Google services use the subscription state to grant or revoke the user's service entitlement. Note: The subscription state might not perfectly align with the user's service entitlement. Some services might continue providing access until the current cycle ends, even if the subscription is immediately canceled. Consult the relevant contract or product policy for specific details. "cancellationDetails": { # Describes the details of a cancelled or cancelling subscription. # Output only. Describes the details of a cancelled subscription. Only applicable to subscription of state `STATE_CANCELLED`. "reason": "A String", # Output only. The reason of the cancellation. }, @@ -1075,7 +1075,7 @@

Method Details

Returns: An object of the form: - { # A subscription serves as a central billing entity between an external partner and Google. The underlying Google services rely on the subscription state to grant or revoke the user's service entitlement. It's important to note that the subscription state may not always perfectly align with the user's service entitlement. For example, some Google services may continue providing access to the user until the current billing cycle ends, even if the subscription has been immediately canceled. However, other services may not do the same. To fully understand the specific details, please consult the relevant contract or product policy. + { # Acts as a central billing entity between an external partner and Google. Google services use the subscription state to grant or revoke the user's service entitlement. Note: The subscription state might not perfectly align with the user's service entitlement. Some services might continue providing access until the current cycle ends, even if the subscription is immediately canceled. Consult the relevant contract or product policy for specific details. "cancellationDetails": { # Describes the details of a cancelled or cancelling subscription. # Output only. Describes the details of a cancelled subscription. Only applicable to subscription of state `STATE_CANCELLED`. "reason": "A String", # Output only. The reason of the cancellation. }, @@ -1239,7 +1239,7 @@

Method Details

An object of the form: { # Response that contains the resumed subscription. - "subscription": { # A subscription serves as a central billing entity between an external partner and Google. The underlying Google services rely on the subscription state to grant or revoke the user's service entitlement. It's important to note that the subscription state may not always perfectly align with the user's service entitlement. For example, some Google services may continue providing access to the user until the current billing cycle ends, even if the subscription has been immediately canceled. However, other services may not do the same. To fully understand the specific details, please consult the relevant contract or product policy. # The resumed subscription resource. + "subscription": { # Acts as a central billing entity between an external partner and Google. Google services use the subscription state to grant or revoke the user's service entitlement. Note: The subscription state might not perfectly align with the user's service entitlement. Some services might continue providing access until the current cycle ends, even if the subscription is immediately canceled. Consult the relevant contract or product policy for specific details. # The resumed subscription resource. "cancellationDetails": { # Describes the details of a cancelled or cancelling subscription. # Output only. Describes the details of a cancelled subscription. Only applicable to subscription of state `STATE_CANCELLED`. "reason": "A String", # Output only. The reason of the cancellation. }, @@ -1397,7 +1397,7 @@

Method Details

An object of the form: { # Response that contains the suspended subscription. - "subscription": { # A subscription serves as a central billing entity between an external partner and Google. The underlying Google services rely on the subscription state to grant or revoke the user's service entitlement. It's important to note that the subscription state may not always perfectly align with the user's service entitlement. For example, some Google services may continue providing access to the user until the current billing cycle ends, even if the subscription has been immediately canceled. However, other services may not do the same. To fully understand the specific details, please consult the relevant contract or product policy. # The suspended subscription resource. + "subscription": { # Acts as a central billing entity between an external partner and Google. Google services use the subscription state to grant or revoke the user's service entitlement. Note: The subscription state might not perfectly align with the user's service entitlement. Some services might continue providing access until the current cycle ends, even if the subscription is immediately canceled. Consult the relevant contract or product policy for specific details. # The suspended subscription resource. "cancellationDetails": { # Describes the details of a cancelled or cancelling subscription. # Output only. Describes the details of a cancelled subscription. Only applicable to subscription of state `STATE_CANCELLED`. "reason": "A String", # Output only. The reason of the cancellation. }, @@ -1555,7 +1555,7 @@

Method Details

An object of the form: { # Response that contains the updated subscription resource. - "subscription": { # A subscription serves as a central billing entity between an external partner and Google. The underlying Google services rely on the subscription state to grant or revoke the user's service entitlement. It's important to note that the subscription state may not always perfectly align with the user's service entitlement. For example, some Google services may continue providing access to the user until the current billing cycle ends, even if the subscription has been immediately canceled. However, other services may not do the same. To fully understand the specific details, please consult the relevant contract or product policy. # The updated subscription resource. + "subscription": { # Acts as a central billing entity between an external partner and Google. Google services use the subscription state to grant or revoke the user's service entitlement. Note: The subscription state might not perfectly align with the user's service entitlement. Some services might continue providing access until the current cycle ends, even if the subscription is immediately canceled. Consult the relevant contract or product policy for specific details. # The updated subscription resource. "cancellationDetails": { # Describes the details of a cancelled or cancelling subscription. # Output only. Describes the details of a cancelled subscription. Only applicable to subscription of state `STATE_CANCELLED`. "reason": "A String", # Output only. The reason of the cancellation. }, diff --git a/docs/dyn/paymentsresellersubscription_v1.partners.userSessions.html b/docs/dyn/paymentsresellersubscription_v1.partners.userSessions.html index ef8b8827ae..d207e870a8 100644 --- a/docs/dyn/paymentsresellersubscription_v1.partners.userSessions.html +++ b/docs/dyn/paymentsresellersubscription_v1.partners.userSessions.html @@ -105,7 +105,7 @@

Method Details

}, }, "parent": "A String", # Required. The parent resource name, which is the identifier of the partner. - "subscription": { # A subscription serves as a central billing entity between an external partner and Google. The underlying Google services rely on the subscription state to grant or revoke the user's service entitlement. It's important to note that the subscription state may not always perfectly align with the user's service entitlement. For example, some Google services may continue providing access to the user until the current billing cycle ends, even if the subscription has been immediately canceled. However, other services may not do the same. To fully understand the specific details, please consult the relevant contract or product policy. # Required. The Subscription to be created. + "subscription": { # Acts as a central billing entity between an external partner and Google. Google services use the subscription state to grant or revoke the user's service entitlement. Note: The subscription state might not perfectly align with the user's service entitlement. Some services might continue providing access until the current cycle ends, even if the subscription is immediately canceled. Consult the relevant contract or product policy for specific details. # Required. The Subscription to be created. "cancellationDetails": { # Describes the details of a cancelled or cancelling subscription. # Output only. Describes the details of a cancelled subscription. Only applicable to subscription of state `STATE_CANCELLED`. "reason": "A String", # Output only. The reason of the cancellation. }, @@ -259,7 +259,7 @@

Method Details

An object of the form: { # Response that contains the details for generated user session. - "userSession": { # A user session contains a short-lived token that includes information required to interact with Google Payments Reseller Platform using the following web endpoints. - A user session token should be generated dynamically for an authenticated user. You should refrain from sharing a token directly with a user in an unauthenticated context, such as SMS, or email. - You can re-generate new session tokens repeatedly for same `generate` request if necessary, regardless of the previous tokens being expired or not. You don't need to worry about multiple sessions resulting in duplicate fulfillments as guaranteed by the same subscription id. Please refer to the [Google Managed Signup](/payments/reseller/subscription/reference/index/User.Signup.Integration/Google.Managed.Signup) documentation for additional integration details. # The generated user session. The token size is proportional to the size of the intent payload. + "userSession": { # Contains a short-lived token containing information required to interact with the Google Payments Reseller Platform via web endpoints. - Generate a user session token dynamically for an authenticated user. Do not share a token directly with a user in an unauthenticated context, such as SMS or email. - You can regenerate new session tokens repeatedly for the same `generate` request if necessary, regardless of whether previous tokens have expired. Multiple sessions will not result in duplicate fulfillments because the `subscription ID` guarantees uniqueness. For more integration details, see the [Google Managed Signup](/payments/reseller/subscription/reference/index/User.Signup.Integration/Google.Managed.Signup) documentation. # The generated user session. The token size is proportional to the size of the intent payload. "expireTime": "A String", # Output only. The time at which the user session expires. "token": "A String", # Output only. The encrypted token of the user session, including the information of the user's intent and request. This token should be provided when redirecting the user to Google. }, diff --git a/docs/dyn/policysimulator_v1.organizations.locations.orgPolicyViolationsPreviews.html b/docs/dyn/policysimulator_v1.organizations.locations.orgPolicyViolationsPreviews.html index 84a422de39..4dc612f35f 100644 --- a/docs/dyn/policysimulator_v1.organizations.locations.orgPolicyViolationsPreviews.html +++ b/docs/dyn/policysimulator_v1.organizations.locations.orgPolicyViolationsPreviews.html @@ -131,7 +131,7 @@

Method Details

"methodTypes": [ # All the operations being applied for this constraint. "A String", ], - "name": "A String", # Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 70 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/` is not counted. + "name": "A String", # Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 71 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/custom.` is not counted. "resourceTypes": [ # Immutable. The resource instance type on which this policy applies. Format will be of the form : `/` Example: * `compute.googleapis.com/Instance`. "A String", ], @@ -315,7 +315,7 @@

Method Details

"methodTypes": [ # All the operations being applied for this constraint. "A String", ], - "name": "A String", # Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 70 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/` is not counted. + "name": "A String", # Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 71 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/custom.` is not counted. "resourceTypes": [ # Immutable. The resource instance type on which this policy applies. Format will be of the form : `/` Example: * `compute.googleapis.com/Instance`. "A String", ], @@ -475,7 +475,7 @@

Method Details

"methodTypes": [ # All the operations being applied for this constraint. "A String", ], - "name": "A String", # Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 70 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/` is not counted. + "name": "A String", # Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 71 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/custom.` is not counted. "resourceTypes": [ # Immutable. The resource instance type on which this policy applies. Format will be of the form : `/` Example: * `compute.googleapis.com/Instance`. "A String", ], diff --git a/docs/dyn/policysimulator_v1.organizations.locations.orgPolicyViolationsPreviews.orgPolicyViolations.html b/docs/dyn/policysimulator_v1.organizations.locations.orgPolicyViolationsPreviews.orgPolicyViolations.html index 68032186be..25a58a83e5 100644 --- a/docs/dyn/policysimulator_v1.organizations.locations.orgPolicyViolationsPreviews.orgPolicyViolations.html +++ b/docs/dyn/policysimulator_v1.organizations.locations.orgPolicyViolationsPreviews.orgPolicyViolations.html @@ -117,7 +117,7 @@

Method Details

"methodTypes": [ # All the operations being applied for this constraint. "A String", ], - "name": "A String", # Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 70 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/` is not counted. + "name": "A String", # Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 71 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/custom.` is not counted. "resourceTypes": [ # Immutable. The resource instance type on which this policy applies. Format will be of the form : `/` Example: * `compute.googleapis.com/Instance`. "A String", ], diff --git a/docs/dyn/policysimulator_v1beta.organizations.locations.orgPolicyViolationsPreviews.html b/docs/dyn/policysimulator_v1beta.organizations.locations.orgPolicyViolationsPreviews.html index ed2bb3bde2..13c03d6289 100644 --- a/docs/dyn/policysimulator_v1beta.organizations.locations.orgPolicyViolationsPreviews.html +++ b/docs/dyn/policysimulator_v1beta.organizations.locations.orgPolicyViolationsPreviews.html @@ -134,7 +134,7 @@

Method Details

"methodTypes": [ # All the operations being applied for this constraint. "A String", ], - "name": "A String", # Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 70 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/` is not counted. + "name": "A String", # Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 71 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/custom.` is not counted. "resourceTypes": [ # Immutable. The resource instance type on which this policy applies. Format will be of the form : `/` Example: * `compute.googleapis.com/Instance`. "A String", ], @@ -313,7 +313,7 @@

Method Details

"methodTypes": [ # All the operations being applied for this constraint. "A String", ], - "name": "A String", # Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 70 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/` is not counted. + "name": "A String", # Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 71 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/custom.` is not counted. "resourceTypes": [ # Immutable. The resource instance type on which this policy applies. Format will be of the form : `/` Example: * `compute.googleapis.com/Instance`. "A String", ], @@ -496,7 +496,7 @@

Method Details

"methodTypes": [ # All the operations being applied for this constraint. "A String", ], - "name": "A String", # Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 70 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/` is not counted. + "name": "A String", # Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 71 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/custom.` is not counted. "resourceTypes": [ # Immutable. The resource instance type on which this policy applies. Format will be of the form : `/` Example: * `compute.googleapis.com/Instance`. "A String", ], @@ -656,7 +656,7 @@

Method Details

"methodTypes": [ # All the operations being applied for this constraint. "A String", ], - "name": "A String", # Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 70 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/` is not counted. + "name": "A String", # Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 71 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/custom.` is not counted. "resourceTypes": [ # Immutable. The resource instance type on which this policy applies. Format will be of the form : `/` Example: * `compute.googleapis.com/Instance`. "A String", ], diff --git a/docs/dyn/policysimulator_v1beta.organizations.locations.orgPolicyViolationsPreviews.orgPolicyViolations.html b/docs/dyn/policysimulator_v1beta.organizations.locations.orgPolicyViolationsPreviews.orgPolicyViolations.html index 9408504f5e..9a03d183c3 100644 --- a/docs/dyn/policysimulator_v1beta.organizations.locations.orgPolicyViolationsPreviews.orgPolicyViolations.html +++ b/docs/dyn/policysimulator_v1beta.organizations.locations.orgPolicyViolationsPreviews.orgPolicyViolations.html @@ -117,7 +117,7 @@

Method Details

"methodTypes": [ # All the operations being applied for this constraint. "A String", ], - "name": "A String", # Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 70 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/` is not counted. + "name": "A String", # Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 71 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/custom.` is not counted. "resourceTypes": [ # Immutable. The resource instance type on which this policy applies. Format will be of the form : `/` Example: * `compute.googleapis.com/Instance`. "A String", ], diff --git a/docs/dyn/pubsub_v1.projects.subscriptions.html b/docs/dyn/pubsub_v1.projects.subscriptions.html index 54d3eeef72..e4cea4586d 100644 --- a/docs/dyn/pubsub_v1.projects.subscriptions.html +++ b/docs/dyn/pubsub_v1.projects.subscriptions.html @@ -215,7 +215,7 @@

Method Details

{ # All supported message transforms types. "aiInference": { # Configuration for making inference requests against Vertex AI models. # Optional. AI Inference. Specifies the Vertex AI endpoint that inference requests built from the Pub/Sub message data and provided parameters will be sent to. "endpoint": "A String", # Required. An endpoint to a Vertex AI model of the form `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`. Vertex AI API requests will be sent to this endpoint. - "serviceAccountEmail": "A String", # Optional. The service account to use to make prediction requests against endpoints. The resource creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent]({$universe.dns_names.final_documentation_domain}/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. + "serviceAccountEmail": "A String", # Optional. The service account to use to make prediction requests against endpoints. The resource creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. "unstructuredInference": { # Configuration for making inferences using arbitrary JSON payloads. # Optional. Requests and responses can be any arbitrary JSON object. "parameters": { # Optional. A parameters object to be included in each inference request. The parameters object is combined with the data field of the Pub/Sub message to form the inference request. "a_key": "", # Properties of the object. @@ -318,7 +318,7 @@

Method Details

{ # All supported message transforms types. "aiInference": { # Configuration for making inference requests against Vertex AI models. # Optional. AI Inference. Specifies the Vertex AI endpoint that inference requests built from the Pub/Sub message data and provided parameters will be sent to. "endpoint": "A String", # Required. An endpoint to a Vertex AI model of the form `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`. Vertex AI API requests will be sent to this endpoint. - "serviceAccountEmail": "A String", # Optional. The service account to use to make prediction requests against endpoints. The resource creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent]({$universe.dns_names.final_documentation_domain}/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. + "serviceAccountEmail": "A String", # Optional. The service account to use to make prediction requests against endpoints. The resource creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. "unstructuredInference": { # Configuration for making inferences using arbitrary JSON payloads. # Optional. Requests and responses can be any arbitrary JSON object. "parameters": { # Optional. A parameters object to be included in each inference request. The parameters object is combined with the data field of the Pub/Sub message to form the inference request. "a_key": "", # Properties of the object. @@ -464,7 +464,7 @@

Method Details

{ # All supported message transforms types. "aiInference": { # Configuration for making inference requests against Vertex AI models. # Optional. AI Inference. Specifies the Vertex AI endpoint that inference requests built from the Pub/Sub message data and provided parameters will be sent to. "endpoint": "A String", # Required. An endpoint to a Vertex AI model of the form `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`. Vertex AI API requests will be sent to this endpoint. - "serviceAccountEmail": "A String", # Optional. The service account to use to make prediction requests against endpoints. The resource creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent]({$universe.dns_names.final_documentation_domain}/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. + "serviceAccountEmail": "A String", # Optional. The service account to use to make prediction requests against endpoints. The resource creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. "unstructuredInference": { # Configuration for making inferences using arbitrary JSON payloads. # Optional. Requests and responses can be any arbitrary JSON object. "parameters": { # Optional. A parameters object to be included in each inference request. The parameters object is combined with the data field of the Pub/Sub message to form the inference request. "a_key": "", # Properties of the object. @@ -614,7 +614,7 @@

Method Details

{ # All supported message transforms types. "aiInference": { # Configuration for making inference requests against Vertex AI models. # Optional. AI Inference. Specifies the Vertex AI endpoint that inference requests built from the Pub/Sub message data and provided parameters will be sent to. "endpoint": "A String", # Required. An endpoint to a Vertex AI model of the form `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`. Vertex AI API requests will be sent to this endpoint. - "serviceAccountEmail": "A String", # Optional. The service account to use to make prediction requests against endpoints. The resource creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent]({$universe.dns_names.final_documentation_domain}/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. + "serviceAccountEmail": "A String", # Optional. The service account to use to make prediction requests against endpoints. The resource creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. "unstructuredInference": { # Configuration for making inferences using arbitrary JSON payloads. # Optional. Requests and responses can be any arbitrary JSON object. "parameters": { # Optional. A parameters object to be included in each inference request. The parameters object is combined with the data field of the Pub/Sub message to form the inference request. "a_key": "", # Properties of the object. @@ -803,7 +803,7 @@

Method Details

{ # All supported message transforms types. "aiInference": { # Configuration for making inference requests against Vertex AI models. # Optional. AI Inference. Specifies the Vertex AI endpoint that inference requests built from the Pub/Sub message data and provided parameters will be sent to. "endpoint": "A String", # Required. An endpoint to a Vertex AI model of the form `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`. Vertex AI API requests will be sent to this endpoint. - "serviceAccountEmail": "A String", # Optional. The service account to use to make prediction requests against endpoints. The resource creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent]({$universe.dns_names.final_documentation_domain}/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. + "serviceAccountEmail": "A String", # Optional. The service account to use to make prediction requests against endpoints. The resource creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. "unstructuredInference": { # Configuration for making inferences using arbitrary JSON payloads. # Optional. Requests and responses can be any arbitrary JSON object. "parameters": { # Optional. A parameters object to be included in each inference request. The parameters object is combined with the data field of the Pub/Sub message to form the inference request. "a_key": "", # Properties of the object. @@ -908,7 +908,7 @@

Method Details

{ # All supported message transforms types. "aiInference": { # Configuration for making inference requests against Vertex AI models. # Optional. AI Inference. Specifies the Vertex AI endpoint that inference requests built from the Pub/Sub message data and provided parameters will be sent to. "endpoint": "A String", # Required. An endpoint to a Vertex AI model of the form `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`. Vertex AI API requests will be sent to this endpoint. - "serviceAccountEmail": "A String", # Optional. The service account to use to make prediction requests against endpoints. The resource creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent]({$universe.dns_names.final_documentation_domain}/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. + "serviceAccountEmail": "A String", # Optional. The service account to use to make prediction requests against endpoints. The resource creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. "unstructuredInference": { # Configuration for making inferences using arbitrary JSON payloads. # Optional. Requests and responses can be any arbitrary JSON object. "parameters": { # Optional. A parameters object to be included in each inference request. The parameters object is combined with the data field of the Pub/Sub message to form the inference request. "a_key": "", # Properties of the object. diff --git a/docs/dyn/pubsub_v1.projects.topics.html b/docs/dyn/pubsub_v1.projects.topics.html index 4438f244f7..d5e8b80142 100644 --- a/docs/dyn/pubsub_v1.projects.topics.html +++ b/docs/dyn/pubsub_v1.projects.topics.html @@ -198,7 +198,7 @@

Method Details

{ # All supported message transforms types. "aiInference": { # Configuration for making inference requests against Vertex AI models. # Optional. AI Inference. Specifies the Vertex AI endpoint that inference requests built from the Pub/Sub message data and provided parameters will be sent to. "endpoint": "A String", # Required. An endpoint to a Vertex AI model of the form `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`. Vertex AI API requests will be sent to this endpoint. - "serviceAccountEmail": "A String", # Optional. The service account to use to make prediction requests against endpoints. The resource creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent]({$universe.dns_names.final_documentation_domain}/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. + "serviceAccountEmail": "A String", # Optional. The service account to use to make prediction requests against endpoints. The resource creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. "unstructuredInference": { # Configuration for making inferences using arbitrary JSON payloads. # Optional. Requests and responses can be any arbitrary JSON object. "parameters": { # Optional. A parameters object to be included in each inference request. The parameters object is combined with the data field of the Pub/Sub message to form the inference request. "a_key": "", # Properties of the object. @@ -301,7 +301,7 @@

Method Details

{ # All supported message transforms types. "aiInference": { # Configuration for making inference requests against Vertex AI models. # Optional. AI Inference. Specifies the Vertex AI endpoint that inference requests built from the Pub/Sub message data and provided parameters will be sent to. "endpoint": "A String", # Required. An endpoint to a Vertex AI model of the form `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`. Vertex AI API requests will be sent to this endpoint. - "serviceAccountEmail": "A String", # Optional. The service account to use to make prediction requests against endpoints. The resource creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent]({$universe.dns_names.final_documentation_domain}/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. + "serviceAccountEmail": "A String", # Optional. The service account to use to make prediction requests against endpoints. The resource creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. "unstructuredInference": { # Configuration for making inferences using arbitrary JSON payloads. # Optional. Requests and responses can be any arbitrary JSON object. "parameters": { # Optional. A parameters object to be included in each inference request. The parameters object is combined with the data field of the Pub/Sub message to form the inference request. "a_key": "", # Properties of the object. @@ -429,7 +429,7 @@

Method Details

{ # All supported message transforms types. "aiInference": { # Configuration for making inference requests against Vertex AI models. # Optional. AI Inference. Specifies the Vertex AI endpoint that inference requests built from the Pub/Sub message data and provided parameters will be sent to. "endpoint": "A String", # Required. An endpoint to a Vertex AI model of the form `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`. Vertex AI API requests will be sent to this endpoint. - "serviceAccountEmail": "A String", # Optional. The service account to use to make prediction requests against endpoints. The resource creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent]({$universe.dns_names.final_documentation_domain}/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. + "serviceAccountEmail": "A String", # Optional. The service account to use to make prediction requests against endpoints. The resource creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. "unstructuredInference": { # Configuration for making inferences using arbitrary JSON payloads. # Optional. Requests and responses can be any arbitrary JSON object. "parameters": { # Optional. A parameters object to be included in each inference request. The parameters object is combined with the data field of the Pub/Sub message to form the inference request. "a_key": "", # Properties of the object. @@ -579,7 +579,7 @@

Method Details

{ # All supported message transforms types. "aiInference": { # Configuration for making inference requests against Vertex AI models. # Optional. AI Inference. Specifies the Vertex AI endpoint that inference requests built from the Pub/Sub message data and provided parameters will be sent to. "endpoint": "A String", # Required. An endpoint to a Vertex AI model of the form `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`. Vertex AI API requests will be sent to this endpoint. - "serviceAccountEmail": "A String", # Optional. The service account to use to make prediction requests against endpoints. The resource creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent]({$universe.dns_names.final_documentation_domain}/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. + "serviceAccountEmail": "A String", # Optional. The service account to use to make prediction requests against endpoints. The resource creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. "unstructuredInference": { # Configuration for making inferences using arbitrary JSON payloads. # Optional. Requests and responses can be any arbitrary JSON object. "parameters": { # Optional. A parameters object to be included in each inference request. The parameters object is combined with the data field of the Pub/Sub message to form the inference request. "a_key": "", # Properties of the object. @@ -701,7 +701,7 @@

Method Details

{ # All supported message transforms types. "aiInference": { # Configuration for making inference requests against Vertex AI models. # Optional. AI Inference. Specifies the Vertex AI endpoint that inference requests built from the Pub/Sub message data and provided parameters will be sent to. "endpoint": "A String", # Required. An endpoint to a Vertex AI model of the form `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`. Vertex AI API requests will be sent to this endpoint. - "serviceAccountEmail": "A String", # Optional. The service account to use to make prediction requests against endpoints. The resource creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent]({$universe.dns_names.final_documentation_domain}/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. + "serviceAccountEmail": "A String", # Optional. The service account to use to make prediction requests against endpoints. The resource creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. "unstructuredInference": { # Configuration for making inferences using arbitrary JSON payloads. # Optional. Requests and responses can be any arbitrary JSON object. "parameters": { # Optional. A parameters object to be included in each inference request. The parameters object is combined with the data field of the Pub/Sub message to form the inference request. "a_key": "", # Properties of the object. @@ -806,7 +806,7 @@

Method Details

{ # All supported message transforms types. "aiInference": { # Configuration for making inference requests against Vertex AI models. # Optional. AI Inference. Specifies the Vertex AI endpoint that inference requests built from the Pub/Sub message data and provided parameters will be sent to. "endpoint": "A String", # Required. An endpoint to a Vertex AI model of the form `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`. Vertex AI API requests will be sent to this endpoint. - "serviceAccountEmail": "A String", # Optional. The service account to use to make prediction requests against endpoints. The resource creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent]({$universe.dns_names.final_documentation_domain}/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. + "serviceAccountEmail": "A String", # Optional. The service account to use to make prediction requests against endpoints. The resource creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. "unstructuredInference": { # Configuration for making inferences using arbitrary JSON payloads. # Optional. Requests and responses can be any arbitrary JSON object. "parameters": { # Optional. A parameters object to be included in each inference request. The parameters object is combined with the data field of the Pub/Sub message to form the inference request. "a_key": "", # Properties of the object. diff --git a/googleapiclient/discovery_cache/documents/admin.directory_v1.json b/googleapiclient/discovery_cache/documents/admin.directory_v1.json index aaa72064bd..108d68d162 100644 --- a/googleapiclient/discovery_cache/documents/admin.directory_v1.json +++ b/googleapiclient/discovery_cache/documents/admin.directory_v1.json @@ -454,7 +454,7 @@ "type": "string" }, "query": { -"description": "Search string in the format given at https://developers.google.com/workspace/admin/directory/v1/list-query-operators", +"description": "Search string in the format given at [List query operators](https://developers.google.com/workspace/admin/directory/v1/list-query-operators).", "location": "query", "type": "string" }, @@ -657,7 +657,7 @@ "type": "string" }, "filter": { -"description": "Optional. Search string in the format given at https://developers.google.com/workspace/admin/directory/v1/list-query-operators", +"description": "Optional. Search string in the format given at [List query operators](https://developers.google.com/workspace/admin/directory/v1/list-query-operators).", "location": "query", "type": "string" }, @@ -3890,7 +3890,7 @@ "users": { "methods": { "createGuest": { -"description": "Create a guest user with access to a [subset of Workspace capabilities](https://support.google.com/a/answer/16558545?hl=en). This feature is currently in Alpha. Please reach out to support if you are interested in trying this feature.", +"description": "Create a guest user with access to a [subset of Workspace capabilities](https://support.google.com/a/answer/16558545). This feature is currently in Alpha. Please reach out to support if you are interested in trying this feature.", "flatPath": "admin/directory/v1/users:createGuest", "httpMethod": "POST", "id": "directory.users.createGuest", @@ -4729,7 +4729,7 @@ } } }, -"revision": "20260210", +"revision": "20260227", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Alias": { diff --git a/googleapiclient/discovery_cache/documents/androidenterprise.v1.json b/googleapiclient/discovery_cache/documents/androidenterprise.v1.json index a76299db08..f995adcf77 100644 --- a/googleapiclient/discovery_cache/documents/androidenterprise.v1.json +++ b/googleapiclient/discovery_cache/documents/androidenterprise.v1.json @@ -180,7 +180,7 @@ ] }, "getState": { -"description": "Retrieves whether a device's access to Google services is enabled or disabled. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. This is only supported for Google-managed users.", +"description": "Checks if a device can access Google apps and services for a user. Returns whether access is \"enabled\" or \"disabled\". A \"disabled\" state prevents the user's Managed Google Account on the device from successfully authenticating with Google. This blocks access to most Google applications and services, including Google Play, as the device cannot prove its entitlement to access them. New devices default to \"disabled\". Important: Enforcement of this state depends on the following conditions: * The user must be a managed google account. * The enterprise must be a managed google domain. * Third-party Android mobile management must be active in the Google Admin Console for the user's Organizational Unit. If these conditions aren't met, access may still be possible even in a \"disabled\" state.", "flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/state", "httpMethod": "GET", "id": "androidenterprise.devices.getState", @@ -249,7 +249,7 @@ ] }, "setState": { -"description": "Sets whether a device's access to Google services is enabled or disabled. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. This is only supported for Google-managed users.", +"description": "Sets whether a device's access to Google services (including Google Play) is enabled or disabled for the specified user. Setting the state to \"enabled\" allows the Google Account to access Google services, while \"disabled\" blocks access by preventing OAuth token issuance. Preconditions for Enforcement: 1. This setting is only effective for Google-managed users. 2. The enterprise must be linked to a Google Managed Domain. 3. Enforcement requires third-party Android mobile management to be enabled within the Google Admin Console for the user's Organizational Unit. If these preconditions are not met, changes to this state may be ignored.", "flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/state", "httpMethod": "PUT", "id": "androidenterprise.devices.setState", @@ -2691,7 +2691,7 @@ } } }, -"revision": "20250720", +"revision": "20260302", "rootUrl": "https://androidenterprise.googleapis.com/", "schemas": { "Administrator": { diff --git a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json index 50c87a0b21..537d402680 100644 --- a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +++ b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json @@ -3118,7 +3118,7 @@ } } }, -"revision": "20260210", +"revision": "20260225", "rootUrl": "https://bigtableadmin.googleapis.com/", "schemas": { "AppProfile": { @@ -5541,13 +5541,13 @@ "type": "boolean" }, "granularity": { -"description": "Immutable. The granularity (i.e. `MILLIS`) at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set to `MILLIS`. Views: `SCHEMA_VIEW`, `FULL`.", +"description": "Immutable. The granularity at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set to `MILLIS`. Views: `SCHEMA_VIEW`, `FULL`.", "enum": [ "TIMESTAMP_GRANULARITY_UNSPECIFIED", "MILLIS" ], "enumDescriptions": [ -"The user did not specify a granularity. Should not be returned. When specified during table creation, MILLIS will be used.", +"The user did not specify a granularity. Should not be returned.", "The table keeps data versioned at a granularity of 1ms." ], "type": "string" diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json index d337b4adef..3fa07aecc5 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json @@ -167,7 +167,7 @@ } } }, -"revision": "20250627", +"revision": "20260227", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { @@ -422,7 +422,7 @@ "id": "GoogleCloudAssetV1p7beta1GcsDestination", "properties": { "uri": { -"description": "The URI of the Cloud Storage object. It's the same URI that is used by gsutil. Example: \"gs://bucket_name/object_name\". See [Viewing and Editing Object Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata) for more information.", +"description": "The URI of the Cloud Storage object. It's the same URI that is used by gcloud storage. Example: \"gs://bucket_name/object_name\". See [Viewing and Editing Object Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata) for more information.", "type": "string" }, "uriPrefix": { diff --git a/googleapiclient/discovery_cache/documents/css.v1.json b/googleapiclient/discovery_cache/documents/css.v1.json index b34f54a90d..2f2bef946f 100644 --- a/googleapiclient/discovery_cache/documents/css.v1.json +++ b/googleapiclient/discovery_cache/documents/css.v1.json @@ -547,7 +547,7 @@ } } }, -"revision": "20250603", +"revision": "20260303", "rootUrl": "https://css.googleapis.com/", "schemas": { "Account": { @@ -889,7 +889,7 @@ "type": "string" }, "sizeTypes": { -"description": "The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided (see [https://support.google.com/merchants/answer/6324497](size type)).", +"description": "The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided (see [size type](https://support.google.com/merchants/answer/6324497).", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/datamanager.v1.json b/googleapiclient/discovery_cache/documents/datamanager.v1.json index 124d8308b7..ea64b99878 100644 --- a/googleapiclient/discovery_cache/documents/datamanager.v1.json +++ b/googleapiclient/discovery_cache/documents/datamanager.v1.json @@ -814,7 +814,7 @@ } } }, -"revision": "20260225", +"revision": "20260228", "rootUrl": "https://datamanager.googleapis.com/", "schemas": { "AdIdentifiers": { @@ -2035,7 +2035,7 @@ "type": "string" }, "matchRatePercentage": { -"description": "Optional. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive.", +"description": "Required. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive.", "format": "int32", "type": "integer" }, diff --git a/googleapiclient/discovery_cache/documents/developerconnect.v1.json b/googleapiclient/discovery_cache/documents/developerconnect.v1.json index f93d4eae94..1361d48244 100644 --- a/googleapiclient/discovery_cache/documents/developerconnect.v1.json +++ b/googleapiclient/discovery_cache/documents/developerconnect.v1.json @@ -1754,7 +1754,7 @@ } } }, -"revision": "20260223", +"revision": "20260302", "rootUrl": "https://developerconnect.googleapis.com/", "schemas": { "AccountConnector": { @@ -2053,7 +2053,7 @@ }, "gitProxyConfig": { "$ref": "GitProxyConfig", -"description": "Optional. Configuration for the git proxy feature. Enabling the git proxy allows clients to perform git operations on the repositories linked in the connection." +"description": "Optional. Configuration for the git proxy feature. Enabling the git proxy allows clients to perform git operations on the repositories linked in the connection. [Learn more](https://docs.cloud.google.com/developer-connect/docs/configure-git-proxy)." }, "githubConfig": { "$ref": "GitHubConfig", diff --git a/googleapiclient/discovery_cache/documents/developerknowledge.v1alpha.json b/googleapiclient/discovery_cache/documents/developerknowledge.v1alpha.json new file mode 100644 index 0000000000..15162028f5 --- /dev/null +++ b/googleapiclient/discovery_cache/documents/developerknowledge.v1alpha.json @@ -0,0 +1,280 @@ +{ +"auth": { +"oauth2": { +"scopes": { +"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://developerknowledge.googleapis.com/", +"batchPath": "batch", +"canonicalName": "Developer Knowledge", +"description": "The Developer Knowledge API provides access to Google's developer knowledge.", +"discoveryVersion": "v1", +"documentationLink": "https://developers.google.com/knowledge", +"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": "developerknowledge:v1alpha", +"kind": "discovery#restDescription", +"mtlsRootUrl": "https://developerknowledge.mtls.googleapis.com/", +"name": "developerknowledge", +"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": { +"documents": { +"methods": { +"batchGet": { +"description": "Retrieves multiple documents, each with its full Markdown content.", +"flatPath": "v1alpha/documents:batchGet", +"httpMethod": "GET", +"id": "developerknowledge.documents.batchGet", +"parameterOrder": [], +"parameters": { +"names": { +"description": "Required. The names of the documents to retrieve. A maximum of 20 documents can be retrieved in a batch. The documents are returned in the same order as the `names` in the request. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets`", +"location": "query", +"repeated": true, +"type": "string" +} +}, +"path": "v1alpha/documents:batchGet", +"response": { +"$ref": "BatchGetDocumentsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Retrieves a single document with its full Markdown content.", +"flatPath": "v1alpha/documents/{documentsId}", +"httpMethod": "GET", +"id": "developerknowledge.documents.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the document to retrieve. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets`", +"location": "path", +"pattern": "^documents/.*$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "Document" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"searchDocumentChunks": { +"description": "Searches for developer knowledge across Google's developer documentation. This method returns document chunks based on the user's query. There can be many chunks of the same Document. To retrieve full documents, use DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments with the DocumentChunk.parent returned in the SearchDocumentChunksResponse.results.", +"flatPath": "v1alpha/documents:searchDocumentChunks", +"httpMethod": "GET", +"id": "developerknowledge.documents.searchDocumentChunks", +"parameterOrder": [], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of results to return. The service may return fewer than this value. If unspecified, at most 5 results will be returned. The maximum value is 20; values above 20 will result in an INVALID_ARGUMENT error.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `SearchDocumentChunks` call. Provide this to retrieve the subsequent page.", +"location": "query", +"type": "string" +}, +"query": { +"description": "Required. The raw query string provided by the user, such as \"How to create a Cloud Storage bucket?\".", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/documents:searchDocumentChunks", +"response": { +"$ref": "SearchDocumentChunksResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +}, +"revision": "20260223", +"rootUrl": "https://developerknowledge.googleapis.com/", +"schemas": { +"BatchGetDocumentsResponse": { +"description": "Response message for DeveloperKnowledge.BatchGetDocuments.", +"id": "BatchGetDocumentsResponse", +"properties": { +"documents": { +"description": "Documents requested.", +"items": { +"$ref": "Document" +}, +"type": "array" +} +}, +"type": "object" +}, +"Document": { +"description": "A Document represents a piece of content from the Developer Knowledge corpus.", +"id": "Document", +"properties": { +"content": { +"description": "Output only. The full content of the document in Markdown format.", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Output only. A description of the document.", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. The resource name of the document. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets`", +"type": "string" +}, +"uri": { +"description": "Output only. The URI of the content, such as `docs.cloud.google.com/storage/docs/creating-buckets`.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"DocumentChunk": { +"description": "A DocumentChunk represents a piece of content from a Document in the DeveloperKnowledge corpus. To fetch the entire document content, pass the `parent` to DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments.", +"id": "DocumentChunk", +"properties": { +"content": { +"description": "Output only. The content of the document chunk.", +"readOnly": true, +"type": "string" +}, +"id": { +"description": "Output only. The ID of this chunk within the document. The chunk ID is unique within a document, but not globally unique across documents. The chunk ID is not stable and may change over time.", +"readOnly": true, +"type": "string" +}, +"parent": { +"description": "Output only. The resource name of the document this chunk is from. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets`", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"SearchDocumentChunksResponse": { +"description": "Response message for DeveloperKnowledge.SearchDocumentChunks.", +"id": "SearchDocumentChunksResponse", +"properties": { +"nextPageToken": { +"description": "Optional. A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +}, +"results": { +"description": "The search results for the given query. Each DocumentChunk in this list contains a snippet of content relevant to the search query. Use the DocumentChunk.parent field of each result with DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments to retrieve the full document content.", +"items": { +"$ref": "DocumentChunk" +}, +"type": "array" +} +}, +"type": "object" +} +}, +"servicePath": "", +"title": "Developer Knowledge API", +"version": "v1alpha", +"version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json index 3ad94affd3..527034615f 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json @@ -868,7 +868,7 @@ } } }, -"revision": "20251203", +"revision": "20260305", "rootUrl": "https://firebaseappdistribution.googleapis.com/", "schemas": { "AndroidxCrawlerOutputPoint": { @@ -1060,7 +1060,7 @@ "type": "string" }, "successCriteria": { -"description": "Optional. A description of criteria the agent should use to determine if the goal has been successfully completed", +"description": "Optional. A visual description of the screen's expected state after the step has been successfully completed. This is referred to as the \"final screen assertion\" in the Firebase console and CLI tools. This field must be provided for the last step in a test case, and is optional for all other steps.", "type": "string" }, "testCase": { diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1.json b/googleapiclient/discovery_cache/documents/gkehub.v1.json index 6bb54f2cae..eb63d4d734 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1.json @@ -2122,7 +2122,7 @@ } } }, -"revision": "20260215", +"revision": "20260226", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -4646,7 +4646,7 @@ "type": "integer" }, "nodeProviderId": { -"description": "Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the node_count will be zero and the node_provider_id will be empty.", +"description": "Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE on Google Cloud), the node_count will be zero and the node_provider_id will be empty.", "readOnly": true, "type": "string" }, @@ -5173,7 +5173,7 @@ }, "gkeCluster": { "$ref": "GkeCluster", -"description": "Optional. Specific information for a GKE-on-GCP cluster." +"description": "Optional. Specific information for a GKE on Google Cloud cluster." }, "googleManaged": { "description": "Output only. Whether the lifecycle of this membership is managed by a google cluster platform service.", @@ -6344,6 +6344,7 @@ false "QUOTA_EXCEEDED_HTTP_FILTERS", "QUOTA_EXCEEDED_TCP_FILTERS", "QUOTA_EXCEEDED_NETWORK_ENDPOINT_GROUPS", +"CONFIG_APPLY_BLOCKED", "LEGACY_MC_SECRETS", "WORKLOAD_IDENTITY_REQUIRED", "NON_STANDARD_BINARY_USAGE", @@ -6399,6 +6400,7 @@ false "HTTPFilter quota exceeded error code.", "TCPFilter quota exceeded error code.", "NetworkEndpointGroup quota exceeded error code.", +"Configuration failed to apply due to fleet being blocked.", "Legacy istio secrets found for multicluster error code", "Workload identity required error code", "Non-standard binary usage error code", diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json index d27c7427be..d4f73683cd 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json @@ -2498,7 +2498,7 @@ } } }, -"revision": "20260215", +"revision": "20260226", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -5269,7 +5269,7 @@ "type": "integer" }, "nodeProviderId": { -"description": "Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the node_count will be zero and the node_provider_id will be empty.", +"description": "Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE on Google Cloud), the node_count will be zero and the node_provider_id will be empty.", "readOnly": true, "type": "string" }, @@ -5857,7 +5857,7 @@ }, "gkeCluster": { "$ref": "GkeCluster", -"description": "Optional. Specific information for a GKE-on-GCP cluster." +"description": "Optional. Specific information for a GKE on Google Cloud cluster." }, "googleManaged": { "description": "Output only. Whether the lifecycle of this membership is managed by a google cluster platform service.", @@ -7554,6 +7554,7 @@ false "QUOTA_EXCEEDED_HTTP_FILTERS", "QUOTA_EXCEEDED_TCP_FILTERS", "QUOTA_EXCEEDED_NETWORK_ENDPOINT_GROUPS", +"CONFIG_APPLY_BLOCKED", "LEGACY_MC_SECRETS", "WORKLOAD_IDENTITY_REQUIRED", "NON_STANDARD_BINARY_USAGE", @@ -7609,6 +7610,7 @@ false "HTTPFilter quota exceeded error code.", "TCPFilter quota exceeded error code.", "NetworkEndpointGroup quota exceeded error code.", +"Configuration failed to apply due to fleet being blocked.", "Legacy istio secrets found for multicluster error code", "Workload identity required error code", "Non-standard binary usage error code", @@ -7796,6 +7798,7 @@ false "QUOTA_EXCEEDED_HTTP_FILTERS", "QUOTA_EXCEEDED_TCP_FILTERS", "QUOTA_EXCEEDED_NETWORK_ENDPOINT_GROUPS", +"CONFIG_APPLY_BLOCKED", "LEGACY_MC_SECRETS", "WORKLOAD_IDENTITY_REQUIRED", "NON_STANDARD_BINARY_USAGE", @@ -7851,6 +7854,7 @@ false "HTTPFilter quota exceeded error code.", "TCPFilter quota exceeded error code.", "NetworkEndpointGroup quota exceeded error code.", +"Configuration failed to apply due to fleet being blocked.", "Legacy istio secrets found for multicluster error code.", "Workload identity required error code.", "Non-standard binary usage error code.", diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json index b952e17fd2..ab349429f4 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json @@ -2354,7 +2354,7 @@ } } }, -"revision": "20260215", +"revision": "20260226", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -4950,7 +4950,7 @@ "type": "integer" }, "nodeProviderId": { -"description": "Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the node_count will be zero and the node_provider_id will be empty.", +"description": "Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE on Google Cloud), the node_count will be zero and the node_provider_id will be empty.", "readOnly": true, "type": "string" }, @@ -5513,7 +5513,7 @@ }, "gkeCluster": { "$ref": "GkeCluster", -"description": "Optional. Specific information for a GKE-on-GCP cluster." +"description": "Optional. Specific information for a GKE on Google Cloud cluster." }, "googleManaged": { "description": "Output only. Whether the lifecycle of this membership is managed by a google cluster platform service.", @@ -7093,6 +7093,7 @@ false "QUOTA_EXCEEDED_HTTP_FILTERS", "QUOTA_EXCEEDED_TCP_FILTERS", "QUOTA_EXCEEDED_NETWORK_ENDPOINT_GROUPS", +"CONFIG_APPLY_BLOCKED", "LEGACY_MC_SECRETS", "WORKLOAD_IDENTITY_REQUIRED", "NON_STANDARD_BINARY_USAGE", @@ -7148,6 +7149,7 @@ false "HTTPFilter quota exceeded error code.", "TCPFilter quota exceeded error code.", "NetworkEndpointGroup quota exceeded error code.", +"Configuration failed to apply due to fleet being blocked.", "Legacy istio secrets found for multicluster error code", "Workload identity required error code", "Non-standard binary usage error code", diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json b/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json index 7548444f29..f066ddcb3e 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json @@ -723,7 +723,7 @@ } } }, -"revision": "20260126", +"revision": "20260226", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "ApplianceCluster": { @@ -731,7 +731,7 @@ "id": "ApplianceCluster", "properties": { "resourceLink": { -"description": "Immutable. Self-link of the GCP resource for the Appliance Cluster. For example: //transferappliance.googleapis.com/projects/my-project/locations/us-west1-a/appliances/my-appliance", +"description": "Immutable. Self-link of the Google Cloud resource for the Appliance Cluster. For example: //transferappliance.googleapis.com/projects/my-project/locations/us-west1-a/appliances/my-appliance", "type": "string" } }, @@ -869,7 +869,7 @@ "id": "EdgeCluster", "properties": { "resourceLink": { -"description": "Immutable. Self-link of the GCP resource for the Edge Cluster. For example: //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster", +"description": "Immutable. Self-link of the Google Cloud resource for the Edge Cluster. For example: //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster", "type": "string" } }, @@ -943,7 +943,7 @@ "type": "boolean" }, "resourceLink": { -"description": "Immutable. Self-link of the GCP resource for the GKE cluster. For example: //container.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster Zonal clusters are also supported.", +"description": "Immutable. Self-link of the Google Cloud resource for the GKE cluster. For example: //container.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster Zonal clusters are also supported.", "type": "string" } }, @@ -998,7 +998,7 @@ "type": "integer" }, "nodeProviderId": { -"description": "Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the node_count will be zero and the node_provider_id will be empty.", +"description": "Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-Google Cloud), the node_count will be zero and the node_provider_id will be empty.", "readOnly": true, "type": "string" }, @@ -1200,7 +1200,7 @@ "additionalProperties": { "type": "string" }, -"description": "Optional. GCP labels for this membership. These labels are not leveraged by multi-cluster features, instead, we prefer cluster labels, which can be set on GKE cluster or other cluster types.", +"description": "Optional. Google Cloud labels for this membership. These labels are not leveraged by multi-cluster features, instead, we prefer cluster labels, which can be set on GKE cluster or other cluster types.", "type": "object" }, "lastConnectionTime": { @@ -1264,7 +1264,7 @@ }, "gkeCluster": { "$ref": "GkeCluster", -"description": "Optional. Specific information for a GKE-on-GCP cluster." +"description": "Optional. Specific information for a GKE-on-Google Cloud cluster." }, "kubernetesMetadata": { "$ref": "KubernetesMetadata", @@ -1362,7 +1362,7 @@ "type": "boolean" }, "resourceLink": { -"description": "Immutable. Self-link of the GCP resource for the GKE Multi-Cloud cluster. For example: //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/awsClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/azureClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/attachedClusters/my-cluster", +"description": "Immutable. Self-link of the Google Cloud resource for the GKE Multi-Cloud cluster. For example: //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/awsClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/azureClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/attachedClusters/my-cluster", "type": "string" } }, @@ -1400,7 +1400,7 @@ "type": "string" }, "resourceLink": { -"description": "Immutable. Self-link of the GCP resource for the GKE On-Prem cluster. For example: //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/vmwareClusters/my-cluster //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/bareMetalClusters/my-cluster", +"description": "Immutable. Self-link of the Google Cloud resource for the GKE On-Prem cluster. For example: //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/vmwareClusters/my-cluster //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/bareMetalClusters/my-cluster", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/gkehub.v2.json b/googleapiclient/discovery_cache/documents/gkehub.v2.json index a3baf00de6..c8c8464c05 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v2.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v2.json @@ -482,7 +482,7 @@ } } }, -"revision": "20260126", +"revision": "20260226", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceState": { @@ -2411,7 +2411,7 @@ "additionalProperties": { "type": "string" }, -"description": "GCP labels for this MembershipFeature.", +"description": "Google Cloud labels for this MembershipFeature.", "type": "object" }, "lifecycleState": { @@ -3076,6 +3076,7 @@ "QUOTA_EXCEEDED_HTTP_FILTERS", "QUOTA_EXCEEDED_TCP_FILTERS", "QUOTA_EXCEEDED_NETWORK_ENDPOINT_GROUPS", +"CONFIG_APPLY_BLOCKED", "LEGACY_MC_SECRETS", "WORKLOAD_IDENTITY_REQUIRED", "NON_STANDARD_BINARY_USAGE", @@ -3131,6 +3132,7 @@ "HTTPFilter quota exceeded error code.", "TCPFilter quota exceeded error code.", "NetworkEndpointGroup quota exceeded error code.", +"Configuration failed to apply due to fleet being blocked.", "Legacy istio secrets found for multicluster error code", "Workload identity required error code", "Non-standard binary usage error code", diff --git a/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json b/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json index bd4abd8f00..99471a47db 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json @@ -482,7 +482,7 @@ } } }, -"revision": "20260126", +"revision": "20260226", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceState": { @@ -2411,7 +2411,7 @@ "additionalProperties": { "type": "string" }, -"description": "GCP labels for this MembershipFeature.", +"description": "Google Cloud labels for this MembershipFeature.", "type": "object" }, "lifecycleState": { @@ -3076,6 +3076,7 @@ "QUOTA_EXCEEDED_HTTP_FILTERS", "QUOTA_EXCEEDED_TCP_FILTERS", "QUOTA_EXCEEDED_NETWORK_ENDPOINT_GROUPS", +"CONFIG_APPLY_BLOCKED", "LEGACY_MC_SECRETS", "WORKLOAD_IDENTITY_REQUIRED", "NON_STANDARD_BINARY_USAGE", @@ -3131,6 +3132,7 @@ "HTTPFilter quota exceeded error code.", "TCPFilter quota exceeded error code.", "NetworkEndpointGroup quota exceeded error code.", +"Configuration failed to apply due to fleet being blocked.", "Legacy istio secrets found for multicluster error code", "Workload identity required error code", "Non-standard binary usage error code", diff --git a/googleapiclient/discovery_cache/documents/gkehub.v2beta.json b/googleapiclient/discovery_cache/documents/gkehub.v2beta.json index 33d7ba9bd3..a6e271ae7d 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v2beta.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v2beta.json @@ -482,7 +482,7 @@ } } }, -"revision": "20260126", +"revision": "20260226", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceState": { @@ -2411,7 +2411,7 @@ "additionalProperties": { "type": "string" }, -"description": "GCP labels for this MembershipFeature.", +"description": "Google Cloud labels for this MembershipFeature.", "type": "object" }, "lifecycleState": { @@ -3076,6 +3076,7 @@ "QUOTA_EXCEEDED_HTTP_FILTERS", "QUOTA_EXCEEDED_TCP_FILTERS", "QUOTA_EXCEEDED_NETWORK_ENDPOINT_GROUPS", +"CONFIG_APPLY_BLOCKED", "LEGACY_MC_SECRETS", "WORKLOAD_IDENTITY_REQUIRED", "NON_STANDARD_BINARY_USAGE", @@ -3131,6 +3132,7 @@ "HTTPFilter quota exceeded error code.", "TCPFilter quota exceeded error code.", "NetworkEndpointGroup quota exceeded error code.", +"Configuration failed to apply due to fleet being blocked.", "Legacy istio secrets found for multicluster error code", "Workload identity required error code", "Non-standard binary usage error code", diff --git a/googleapiclient/discovery_cache/documents/gkeonprem.v1.json b/googleapiclient/discovery_cache/documents/gkeonprem.v1.json index 4b506d7af2..fde8ab71b1 100644 --- a/googleapiclient/discovery_cache/documents/gkeonprem.v1.json +++ b/googleapiclient/discovery_cache/documents/gkeonprem.v1.json @@ -135,7 +135,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service.", +"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "gkeonprem.projects.locations.list", @@ -3163,7 +3163,7 @@ } } }, -"revision": "20251203", +"revision": "20260225", "rootUrl": "https://gkeonprem.googleapis.com/", "schemas": { "Authorization": { diff --git a/googleapiclient/discovery_cache/documents/iam.v1.json b/googleapiclient/discovery_cache/documents/iam.v1.json index c53c91de91..7114979375 100644 --- a/googleapiclient/discovery_cache/documents/iam.v1.json +++ b/googleapiclient/discovery_cache/documents/iam.v1.json @@ -4160,7 +4160,7 @@ } } }, -"revision": "20260213", +"revision": "20260227", "rootUrl": "https://iam.googleapis.com/", "schemas": { "AccessRestrictions": { @@ -4546,12 +4546,14 @@ "enum": [ "ATTRIBUTES_TYPE_UNSPECIFIED", "AZURE_AD_GROUPS_MAIL", -"AZURE_AD_GROUPS_ID" +"AZURE_AD_GROUPS_ID", +"AZURE_AD_GROUPS_DISPLAY_NAME" ], "enumDescriptions": [ "No AttributesType specified.", "Used to get the user's group claims from the Microsoft Entra ID identity provider using the configuration provided in ExtraAttributesOAuth2Client. The `mail` property of the `microsoft.graph.group` object is used for claim mapping. See https://learn.microsoft.com/en-us/graph/api/resources/group?view=graph-rest-1.0#properties for more details on `microsoft.graph.group` properties. The group mail addresses of the user's groups that are returned from Microsoft Entra ID can be mapped by using the following attributes: * OIDC: `assertion.groups` * SAML: `assertion.attributes.groups`", -"Used to get the user's group claims from the Microsoft Entra ID identity provider using the configuration provided in ExtraAttributesOAuth2Client. The `id` property of the `microsoft.graph.group` object is used for claim mapping. See https://learn.microsoft.com/en-us/graph/api/resources/group?view=graph-rest-1.0#properties for more details on `microsoft.graph.group` properties. The group IDs of the user's groups that are returned from Microsoft Entra ID can be mapped by using the following attributes: * OIDC: `assertion.groups` * SAML: `assertion.attributes.groups`" +"Used to get the user's group claims from the Microsoft Entra ID identity provider using the configuration provided in ExtraAttributesOAuth2Client. The `id` property of the `microsoft.graph.group` object is used for claim mapping. See https://learn.microsoft.com/en-us/graph/api/resources/group?view=graph-rest-1.0#properties for more details on `microsoft.graph.group` properties. The group IDs of the user's groups that are returned from Microsoft Entra ID can be mapped by using the following attributes: * OIDC: `assertion.groups` * SAML: `assertion.attributes.groups`", +"Used to get the user's group claims from the Microsoft Entra ID identity provider using the configuration provided in ExtraAttributesOAuth2Client. The `displayName` property of the `microsoft.graph.group` object is used for claim mapping. See https://learn.microsoft.com/en-us/graph/api/resources/group?view=graph-rest-1.0#properties for more details on `microsoft.graph.group` properties. The display names of the user's groups that are returned from Microsoft Entra ID can be mapped by using the following attributes: * OIDC: `assertion.groups` * SAML: `assertion.attributes.groups`" ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/language.v1.json b/googleapiclient/discovery_cache/documents/language.v1.json index 8d15719567..6cb6ae69b5 100644 --- a/googleapiclient/discovery_cache/documents/language.v1.json +++ b/googleapiclient/discovery_cache/documents/language.v1.json @@ -246,7 +246,7 @@ } } }, -"revision": "20260223", +"revision": "20260302", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -701,6 +701,9 @@ "C3", "C4", "C4A", +"C4D", +"N4", +"N4A", "M2", "M1", "N1", @@ -723,6 +726,9 @@ "", "", "", +"", +"", +"", "MEMORY_OPTIMIZED_UPGRADE_PREMIUM", "MEMORY_OPTIMIZED", "", @@ -946,7 +952,64 @@ "C4A_HIGHMEM_32", "C4A_HIGHMEM_48", "C4A_HIGHMEM_64", -"C4A_HIGHMEM_72" +"C4A_HIGHMEM_72", +"C4D_STANDARD_8", +"C4D_STANDARD_16", +"C4D_STANDARD_32", +"C4D_STANDARD_48", +"C4D_STANDARD_64", +"C4D_STANDARD_96", +"C4D_STANDARD_192", +"C4D_STANDARD_384", +"C4D_HIGHCPU_8", +"C4D_HIGHCPU_16", +"C4D_HIGHCPU_32", +"C4D_HIGHCPU_48", +"C4D_HIGHCPU_64", +"C4D_HIGHCPU_96", +"C4D_HIGHCPU_192", +"C4D_HIGHCPU_384", +"C4D_HIGHMEM_8", +"C4D_HIGHMEM_16", +"C4D_HIGHMEM_32", +"C4D_HIGHMEM_48", +"C4D_HIGHMEM_64", +"C4D_HIGHMEM_96", +"C4D_HIGHMEM_192", +"C4D_HIGHMEM_384", +"N4_STANDARD_8", +"N4_STANDARD_16", +"N4_STANDARD_32", +"N4_STANDARD_48", +"N4_STANDARD_64", +"N4_STANDARD_80", +"N4_HIGHCPU_8", +"N4_HIGHCPU_16", +"N4_HIGHCPU_32", +"N4_HIGHCPU_48", +"N4_HIGHCPU_64", +"N4_HIGHCPU_80", +"N4_HIGHMEM_8", +"N4_HIGHMEM_16", +"N4_HIGHMEM_32", +"N4_HIGHMEM_48", +"N4_HIGHMEM_64", +"N4_HIGHMEM_80", +"N4A_STANDARD_8", +"N4A_STANDARD_16", +"N4A_STANDARD_32", +"N4A_STANDARD_48", +"N4A_STANDARD_64", +"N4A_HIGHCPU_8", +"N4A_HIGHCPU_16", +"N4A_HIGHCPU_32", +"N4A_HIGHCPU_48", +"N4A_HIGHCPU_64", +"N4A_HIGHMEM_8", +"N4A_HIGHMEM_16", +"N4A_HIGHMEM_32", +"N4A_HIGHMEM_48", +"N4A_HIGHMEM_64" ], "enumDescriptions": [ "", @@ -1160,6 +1223,63 @@ "", "", "", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", "" ], "type": "string" @@ -1781,7 +1901,64 @@ "C4A_HIGHMEM_32", "C4A_HIGHMEM_48", "C4A_HIGHMEM_64", -"C4A_HIGHMEM_72" +"C4A_HIGHMEM_72", +"C4D_STANDARD_8", +"C4D_STANDARD_16", +"C4D_STANDARD_32", +"C4D_STANDARD_48", +"C4D_STANDARD_64", +"C4D_STANDARD_96", +"C4D_STANDARD_192", +"C4D_STANDARD_384", +"C4D_HIGHCPU_8", +"C4D_HIGHCPU_16", +"C4D_HIGHCPU_32", +"C4D_HIGHCPU_48", +"C4D_HIGHCPU_64", +"C4D_HIGHCPU_96", +"C4D_HIGHCPU_192", +"C4D_HIGHCPU_384", +"C4D_HIGHMEM_8", +"C4D_HIGHMEM_16", +"C4D_HIGHMEM_32", +"C4D_HIGHMEM_48", +"C4D_HIGHMEM_64", +"C4D_HIGHMEM_96", +"C4D_HIGHMEM_192", +"C4D_HIGHMEM_384", +"N4_STANDARD_8", +"N4_STANDARD_16", +"N4_STANDARD_32", +"N4_STANDARD_48", +"N4_STANDARD_64", +"N4_STANDARD_80", +"N4_HIGHCPU_8", +"N4_HIGHCPU_16", +"N4_HIGHCPU_32", +"N4_HIGHCPU_48", +"N4_HIGHCPU_64", +"N4_HIGHCPU_80", +"N4_HIGHMEM_8", +"N4_HIGHMEM_16", +"N4_HIGHMEM_32", +"N4_HIGHMEM_48", +"N4_HIGHMEM_64", +"N4_HIGHMEM_80", +"N4A_STANDARD_8", +"N4A_STANDARD_16", +"N4A_STANDARD_32", +"N4A_STANDARD_48", +"N4A_STANDARD_64", +"N4A_HIGHCPU_8", +"N4A_HIGHCPU_16", +"N4A_HIGHCPU_32", +"N4A_HIGHCPU_48", +"N4A_HIGHCPU_64", +"N4A_HIGHMEM_8", +"N4A_HIGHMEM_16", +"N4A_HIGHMEM_32", +"N4A_HIGHMEM_48", +"N4A_HIGHMEM_64" ], "enumDescriptions": [ "", @@ -1995,6 +2172,63 @@ "", "", "", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", "" ], "type": "string" @@ -2565,7 +2799,64 @@ "C4A_HIGHMEM_32", "C4A_HIGHMEM_48", "C4A_HIGHMEM_64", -"C4A_HIGHMEM_72" +"C4A_HIGHMEM_72", +"C4D_STANDARD_8", +"C4D_STANDARD_16", +"C4D_STANDARD_32", +"C4D_STANDARD_48", +"C4D_STANDARD_64", +"C4D_STANDARD_96", +"C4D_STANDARD_192", +"C4D_STANDARD_384", +"C4D_HIGHCPU_8", +"C4D_HIGHCPU_16", +"C4D_HIGHCPU_32", +"C4D_HIGHCPU_48", +"C4D_HIGHCPU_64", +"C4D_HIGHCPU_96", +"C4D_HIGHCPU_192", +"C4D_HIGHCPU_384", +"C4D_HIGHMEM_8", +"C4D_HIGHMEM_16", +"C4D_HIGHMEM_32", +"C4D_HIGHMEM_48", +"C4D_HIGHMEM_64", +"C4D_HIGHMEM_96", +"C4D_HIGHMEM_192", +"C4D_HIGHMEM_384", +"N4_STANDARD_8", +"N4_STANDARD_16", +"N4_STANDARD_32", +"N4_STANDARD_48", +"N4_STANDARD_64", +"N4_STANDARD_80", +"N4_HIGHCPU_8", +"N4_HIGHCPU_16", +"N4_HIGHCPU_32", +"N4_HIGHCPU_48", +"N4_HIGHCPU_64", +"N4_HIGHCPU_80", +"N4_HIGHMEM_8", +"N4_HIGHMEM_16", +"N4_HIGHMEM_32", +"N4_HIGHMEM_48", +"N4_HIGHMEM_64", +"N4_HIGHMEM_80", +"N4A_STANDARD_8", +"N4A_STANDARD_16", +"N4A_STANDARD_32", +"N4A_STANDARD_48", +"N4A_STANDARD_64", +"N4A_HIGHCPU_8", +"N4A_HIGHCPU_16", +"N4A_HIGHCPU_32", +"N4A_HIGHCPU_48", +"N4A_HIGHCPU_64", +"N4A_HIGHMEM_8", +"N4A_HIGHMEM_16", +"N4A_HIGHMEM_32", +"N4A_HIGHMEM_48", +"N4A_HIGHMEM_64" ], "enumDescriptions": [ "", @@ -2779,6 +3070,63 @@ "", "", "", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", "" ], "type": "string" @@ -2804,6 +3152,9 @@ "G4", "C4", "C4A", +"C4D", +"N4", +"N4A", "C3", "M2", "M1", @@ -2827,6 +3178,9 @@ "", "", "", +"", +"", +"", "MEMORY_OPTIMIZED_UPGRADE_PREMIUM", "MEMORY_OPTIMIZED", "", diff --git a/googleapiclient/discovery_cache/documents/language.v1beta2.json b/googleapiclient/discovery_cache/documents/language.v1beta2.json index 683613fc23..aeac1ac8f2 100644 --- a/googleapiclient/discovery_cache/documents/language.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/language.v1beta2.json @@ -246,7 +246,7 @@ } } }, -"revision": "20260223", +"revision": "20260302", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -701,6 +701,9 @@ "C3", "C4", "C4A", +"C4D", +"N4", +"N4A", "M2", "M1", "N1", @@ -723,6 +726,9 @@ "", "", "", +"", +"", +"", "MEMORY_OPTIMIZED_UPGRADE_PREMIUM", "MEMORY_OPTIMIZED", "", @@ -946,7 +952,64 @@ "C4A_HIGHMEM_32", "C4A_HIGHMEM_48", "C4A_HIGHMEM_64", -"C4A_HIGHMEM_72" +"C4A_HIGHMEM_72", +"C4D_STANDARD_8", +"C4D_STANDARD_16", +"C4D_STANDARD_32", +"C4D_STANDARD_48", +"C4D_STANDARD_64", +"C4D_STANDARD_96", +"C4D_STANDARD_192", +"C4D_STANDARD_384", +"C4D_HIGHCPU_8", +"C4D_HIGHCPU_16", +"C4D_HIGHCPU_32", +"C4D_HIGHCPU_48", +"C4D_HIGHCPU_64", +"C4D_HIGHCPU_96", +"C4D_HIGHCPU_192", +"C4D_HIGHCPU_384", +"C4D_HIGHMEM_8", +"C4D_HIGHMEM_16", +"C4D_HIGHMEM_32", +"C4D_HIGHMEM_48", +"C4D_HIGHMEM_64", +"C4D_HIGHMEM_96", +"C4D_HIGHMEM_192", +"C4D_HIGHMEM_384", +"N4_STANDARD_8", +"N4_STANDARD_16", +"N4_STANDARD_32", +"N4_STANDARD_48", +"N4_STANDARD_64", +"N4_STANDARD_80", +"N4_HIGHCPU_8", +"N4_HIGHCPU_16", +"N4_HIGHCPU_32", +"N4_HIGHCPU_48", +"N4_HIGHCPU_64", +"N4_HIGHCPU_80", +"N4_HIGHMEM_8", +"N4_HIGHMEM_16", +"N4_HIGHMEM_32", +"N4_HIGHMEM_48", +"N4_HIGHMEM_64", +"N4_HIGHMEM_80", +"N4A_STANDARD_8", +"N4A_STANDARD_16", +"N4A_STANDARD_32", +"N4A_STANDARD_48", +"N4A_STANDARD_64", +"N4A_HIGHCPU_8", +"N4A_HIGHCPU_16", +"N4A_HIGHCPU_32", +"N4A_HIGHCPU_48", +"N4A_HIGHCPU_64", +"N4A_HIGHMEM_8", +"N4A_HIGHMEM_16", +"N4A_HIGHMEM_32", +"N4A_HIGHMEM_48", +"N4A_HIGHMEM_64" ], "enumDescriptions": [ "", @@ -1160,6 +1223,63 @@ "", "", "", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", "" ], "type": "string" @@ -1799,7 +1919,64 @@ "C4A_HIGHMEM_32", "C4A_HIGHMEM_48", "C4A_HIGHMEM_64", -"C4A_HIGHMEM_72" +"C4A_HIGHMEM_72", +"C4D_STANDARD_8", +"C4D_STANDARD_16", +"C4D_STANDARD_32", +"C4D_STANDARD_48", +"C4D_STANDARD_64", +"C4D_STANDARD_96", +"C4D_STANDARD_192", +"C4D_STANDARD_384", +"C4D_HIGHCPU_8", +"C4D_HIGHCPU_16", +"C4D_HIGHCPU_32", +"C4D_HIGHCPU_48", +"C4D_HIGHCPU_64", +"C4D_HIGHCPU_96", +"C4D_HIGHCPU_192", +"C4D_HIGHCPU_384", +"C4D_HIGHMEM_8", +"C4D_HIGHMEM_16", +"C4D_HIGHMEM_32", +"C4D_HIGHMEM_48", +"C4D_HIGHMEM_64", +"C4D_HIGHMEM_96", +"C4D_HIGHMEM_192", +"C4D_HIGHMEM_384", +"N4_STANDARD_8", +"N4_STANDARD_16", +"N4_STANDARD_32", +"N4_STANDARD_48", +"N4_STANDARD_64", +"N4_STANDARD_80", +"N4_HIGHCPU_8", +"N4_HIGHCPU_16", +"N4_HIGHCPU_32", +"N4_HIGHCPU_48", +"N4_HIGHCPU_64", +"N4_HIGHCPU_80", +"N4_HIGHMEM_8", +"N4_HIGHMEM_16", +"N4_HIGHMEM_32", +"N4_HIGHMEM_48", +"N4_HIGHMEM_64", +"N4_HIGHMEM_80", +"N4A_STANDARD_8", +"N4A_STANDARD_16", +"N4A_STANDARD_32", +"N4A_STANDARD_48", +"N4A_STANDARD_64", +"N4A_HIGHCPU_8", +"N4A_HIGHCPU_16", +"N4A_HIGHCPU_32", +"N4A_HIGHCPU_48", +"N4A_HIGHCPU_64", +"N4A_HIGHMEM_8", +"N4A_HIGHMEM_16", +"N4A_HIGHMEM_32", +"N4A_HIGHMEM_48", +"N4A_HIGHMEM_64" ], "enumDescriptions": [ "", @@ -2013,6 +2190,63 @@ "", "", "", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", "" ], "type": "string" @@ -2583,7 +2817,64 @@ "C4A_HIGHMEM_32", "C4A_HIGHMEM_48", "C4A_HIGHMEM_64", -"C4A_HIGHMEM_72" +"C4A_HIGHMEM_72", +"C4D_STANDARD_8", +"C4D_STANDARD_16", +"C4D_STANDARD_32", +"C4D_STANDARD_48", +"C4D_STANDARD_64", +"C4D_STANDARD_96", +"C4D_STANDARD_192", +"C4D_STANDARD_384", +"C4D_HIGHCPU_8", +"C4D_HIGHCPU_16", +"C4D_HIGHCPU_32", +"C4D_HIGHCPU_48", +"C4D_HIGHCPU_64", +"C4D_HIGHCPU_96", +"C4D_HIGHCPU_192", +"C4D_HIGHCPU_384", +"C4D_HIGHMEM_8", +"C4D_HIGHMEM_16", +"C4D_HIGHMEM_32", +"C4D_HIGHMEM_48", +"C4D_HIGHMEM_64", +"C4D_HIGHMEM_96", +"C4D_HIGHMEM_192", +"C4D_HIGHMEM_384", +"N4_STANDARD_8", +"N4_STANDARD_16", +"N4_STANDARD_32", +"N4_STANDARD_48", +"N4_STANDARD_64", +"N4_STANDARD_80", +"N4_HIGHCPU_8", +"N4_HIGHCPU_16", +"N4_HIGHCPU_32", +"N4_HIGHCPU_48", +"N4_HIGHCPU_64", +"N4_HIGHCPU_80", +"N4_HIGHMEM_8", +"N4_HIGHMEM_16", +"N4_HIGHMEM_32", +"N4_HIGHMEM_48", +"N4_HIGHMEM_64", +"N4_HIGHMEM_80", +"N4A_STANDARD_8", +"N4A_STANDARD_16", +"N4A_STANDARD_32", +"N4A_STANDARD_48", +"N4A_STANDARD_64", +"N4A_HIGHCPU_8", +"N4A_HIGHCPU_16", +"N4A_HIGHCPU_32", +"N4A_HIGHCPU_48", +"N4A_HIGHCPU_64", +"N4A_HIGHMEM_8", +"N4A_HIGHMEM_16", +"N4A_HIGHMEM_32", +"N4A_HIGHMEM_48", +"N4A_HIGHMEM_64" ], "enumDescriptions": [ "", @@ -2797,6 +3088,63 @@ "", "", "", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", "" ], "type": "string" @@ -2822,6 +3170,9 @@ "G4", "C4", "C4A", +"C4D", +"N4", +"N4A", "C3", "M2", "M1", @@ -2845,6 +3196,9 @@ "", "", "", +"", +"", +"", "MEMORY_OPTIMIZED_UPGRADE_PREMIUM", "MEMORY_OPTIMIZED", "", diff --git a/googleapiclient/discovery_cache/documents/language.v2.json b/googleapiclient/discovery_cache/documents/language.v2.json index 5520afc77c..e20e3f06e8 100644 --- a/googleapiclient/discovery_cache/documents/language.v2.json +++ b/googleapiclient/discovery_cache/documents/language.v2.json @@ -208,7 +208,7 @@ } } }, -"revision": "20260223", +"revision": "20260302", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -526,6 +526,9 @@ "C3", "C4", "C4A", +"C4D", +"N4", +"N4A", "M2", "M1", "N1", @@ -548,6 +551,9 @@ "", "", "", +"", +"", +"", "MEMORY_OPTIMIZED_UPGRADE_PREMIUM", "MEMORY_OPTIMIZED", "", @@ -771,7 +777,64 @@ "C4A_HIGHMEM_32", "C4A_HIGHMEM_48", "C4A_HIGHMEM_64", -"C4A_HIGHMEM_72" +"C4A_HIGHMEM_72", +"C4D_STANDARD_8", +"C4D_STANDARD_16", +"C4D_STANDARD_32", +"C4D_STANDARD_48", +"C4D_STANDARD_64", +"C4D_STANDARD_96", +"C4D_STANDARD_192", +"C4D_STANDARD_384", +"C4D_HIGHCPU_8", +"C4D_HIGHCPU_16", +"C4D_HIGHCPU_32", +"C4D_HIGHCPU_48", +"C4D_HIGHCPU_64", +"C4D_HIGHCPU_96", +"C4D_HIGHCPU_192", +"C4D_HIGHCPU_384", +"C4D_HIGHMEM_8", +"C4D_HIGHMEM_16", +"C4D_HIGHMEM_32", +"C4D_HIGHMEM_48", +"C4D_HIGHMEM_64", +"C4D_HIGHMEM_96", +"C4D_HIGHMEM_192", +"C4D_HIGHMEM_384", +"N4_STANDARD_8", +"N4_STANDARD_16", +"N4_STANDARD_32", +"N4_STANDARD_48", +"N4_STANDARD_64", +"N4_STANDARD_80", +"N4_HIGHCPU_8", +"N4_HIGHCPU_16", +"N4_HIGHCPU_32", +"N4_HIGHCPU_48", +"N4_HIGHCPU_64", +"N4_HIGHCPU_80", +"N4_HIGHMEM_8", +"N4_HIGHMEM_16", +"N4_HIGHMEM_32", +"N4_HIGHMEM_48", +"N4_HIGHMEM_64", +"N4_HIGHMEM_80", +"N4A_STANDARD_8", +"N4A_STANDARD_16", +"N4A_STANDARD_32", +"N4A_STANDARD_48", +"N4A_STANDARD_64", +"N4A_HIGHCPU_8", +"N4A_HIGHCPU_16", +"N4A_HIGHCPU_32", +"N4A_HIGHCPU_48", +"N4A_HIGHCPU_64", +"N4A_HIGHMEM_8", +"N4A_HIGHMEM_16", +"N4A_HIGHMEM_32", +"N4A_HIGHMEM_48", +"N4A_HIGHMEM_64" ], "enumDescriptions": [ "", @@ -985,6 +1048,63 @@ "", "", "", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", "" ], "type": "string" @@ -1420,7 +1540,64 @@ "C4A_HIGHMEM_32", "C4A_HIGHMEM_48", "C4A_HIGHMEM_64", -"C4A_HIGHMEM_72" +"C4A_HIGHMEM_72", +"C4D_STANDARD_8", +"C4D_STANDARD_16", +"C4D_STANDARD_32", +"C4D_STANDARD_48", +"C4D_STANDARD_64", +"C4D_STANDARD_96", +"C4D_STANDARD_192", +"C4D_STANDARD_384", +"C4D_HIGHCPU_8", +"C4D_HIGHCPU_16", +"C4D_HIGHCPU_32", +"C4D_HIGHCPU_48", +"C4D_HIGHCPU_64", +"C4D_HIGHCPU_96", +"C4D_HIGHCPU_192", +"C4D_HIGHCPU_384", +"C4D_HIGHMEM_8", +"C4D_HIGHMEM_16", +"C4D_HIGHMEM_32", +"C4D_HIGHMEM_48", +"C4D_HIGHMEM_64", +"C4D_HIGHMEM_96", +"C4D_HIGHMEM_192", +"C4D_HIGHMEM_384", +"N4_STANDARD_8", +"N4_STANDARD_16", +"N4_STANDARD_32", +"N4_STANDARD_48", +"N4_STANDARD_64", +"N4_STANDARD_80", +"N4_HIGHCPU_8", +"N4_HIGHCPU_16", +"N4_HIGHCPU_32", +"N4_HIGHCPU_48", +"N4_HIGHCPU_64", +"N4_HIGHCPU_80", +"N4_HIGHMEM_8", +"N4_HIGHMEM_16", +"N4_HIGHMEM_32", +"N4_HIGHMEM_48", +"N4_HIGHMEM_64", +"N4_HIGHMEM_80", +"N4A_STANDARD_8", +"N4A_STANDARD_16", +"N4A_STANDARD_32", +"N4A_STANDARD_48", +"N4A_STANDARD_64", +"N4A_HIGHCPU_8", +"N4A_HIGHCPU_16", +"N4A_HIGHCPU_32", +"N4A_HIGHCPU_48", +"N4A_HIGHCPU_64", +"N4A_HIGHMEM_8", +"N4A_HIGHMEM_16", +"N4A_HIGHMEM_32", +"N4A_HIGHMEM_48", +"N4A_HIGHMEM_64" ], "enumDescriptions": [ "", @@ -1634,6 +1811,63 @@ "", "", "", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", "" ], "type": "string" @@ -1959,7 +2193,64 @@ "C4A_HIGHMEM_32", "C4A_HIGHMEM_48", "C4A_HIGHMEM_64", -"C4A_HIGHMEM_72" +"C4A_HIGHMEM_72", +"C4D_STANDARD_8", +"C4D_STANDARD_16", +"C4D_STANDARD_32", +"C4D_STANDARD_48", +"C4D_STANDARD_64", +"C4D_STANDARD_96", +"C4D_STANDARD_192", +"C4D_STANDARD_384", +"C4D_HIGHCPU_8", +"C4D_HIGHCPU_16", +"C4D_HIGHCPU_32", +"C4D_HIGHCPU_48", +"C4D_HIGHCPU_64", +"C4D_HIGHCPU_96", +"C4D_HIGHCPU_192", +"C4D_HIGHCPU_384", +"C4D_HIGHMEM_8", +"C4D_HIGHMEM_16", +"C4D_HIGHMEM_32", +"C4D_HIGHMEM_48", +"C4D_HIGHMEM_64", +"C4D_HIGHMEM_96", +"C4D_HIGHMEM_192", +"C4D_HIGHMEM_384", +"N4_STANDARD_8", +"N4_STANDARD_16", +"N4_STANDARD_32", +"N4_STANDARD_48", +"N4_STANDARD_64", +"N4_STANDARD_80", +"N4_HIGHCPU_8", +"N4_HIGHCPU_16", +"N4_HIGHCPU_32", +"N4_HIGHCPU_48", +"N4_HIGHCPU_64", +"N4_HIGHCPU_80", +"N4_HIGHMEM_8", +"N4_HIGHMEM_16", +"N4_HIGHMEM_32", +"N4_HIGHMEM_48", +"N4_HIGHMEM_64", +"N4_HIGHMEM_80", +"N4A_STANDARD_8", +"N4A_STANDARD_16", +"N4A_STANDARD_32", +"N4A_STANDARD_48", +"N4A_STANDARD_64", +"N4A_HIGHCPU_8", +"N4A_HIGHCPU_16", +"N4A_HIGHCPU_32", +"N4A_HIGHCPU_48", +"N4A_HIGHCPU_64", +"N4A_HIGHMEM_8", +"N4A_HIGHMEM_16", +"N4A_HIGHMEM_32", +"N4A_HIGHMEM_48", +"N4A_HIGHMEM_64" ], "enumDescriptions": [ "", @@ -2173,6 +2464,63 @@ "", "", "", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", "" ], "type": "string" @@ -2198,6 +2546,9 @@ "G4", "C4", "C4A", +"C4D", +"N4", +"N4A", "C3", "M2", "M1", @@ -2221,6 +2572,9 @@ "", "", "", +"", +"", +"", "MEMORY_OPTIMIZED_UPGRADE_PREMIUM", "MEMORY_OPTIMIZED", "", diff --git a/googleapiclient/discovery_cache/documents/marketingplatformadmin.v1alpha.json b/googleapiclient/discovery_cache/documents/marketingplatformadmin.v1alpha.json index 63dc0207b5..7b1e080eb4 100644 --- a/googleapiclient/discovery_cache/documents/marketingplatformadmin.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/marketingplatformadmin.v1alpha.json @@ -140,7 +140,7 @@ ] }, "get": { -"description": "Lookup for a single organization.", +"description": "Looks up a single organization.", "flatPath": "v1alpha/organizations/{organizationsId}", "httpMethod": "GET", "id": "marketingplatformadmin.organizations.get", @@ -194,7 +194,7 @@ ] }, "reportPropertyUsage": { -"description": "Get the usage and billing data for properties within the organization for the specified month. Per direct client org, user needs to be OrgAdmin/BillingAdmin on the organization in order to view the billing and usage data. Per sales partner client org, user needs to be OrgAdmin/BillingAdmin on the sales partner org in order to view the billing and usage data, or OrgAdmin/BillingAdmin on the sales partner client org in order to view the usage data only.", +"description": "Gets the usage and billing data for properties within the organization for the specified month. Per direct client org, user needs to be OrgAdmin/BillingAdmin on the organization in order to view the billing and usage data. Per sales partner client org, user needs to be OrgAdmin/BillingAdmin on the sales partner org in order to view the billing and usage data, or OrgAdmin/BillingAdmin on the sales partner client org in order to view the usage data only.", "flatPath": "v1alpha/organizations/{organizationsId}:reportPropertyUsage", "httpMethod": "POST", "id": "marketingplatformadmin.organizations.reportPropertyUsage", @@ -349,7 +349,7 @@ } } }, -"revision": "20251029", +"revision": "20260303", "rootUrl": "https://marketingplatformadmin.googleapis.com/", "schemas": { "AnalyticsAccountLink": { diff --git a/googleapiclient/discovery_cache/documents/orgpolicy.v2.json b/googleapiclient/discovery_cache/documents/orgpolicy.v2.json index b0f0b7368f..183e4d7778 100644 --- a/googleapiclient/discovery_cache/documents/orgpolicy.v2.json +++ b/googleapiclient/discovery_cache/documents/orgpolicy.v2.json @@ -499,7 +499,7 @@ ], "parameters": { "name": { -"description": "Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 70 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/` is not counted.", +"description": "Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 71 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/custom.` is not counted.", "location": "path", "pattern": "^organizations/[^/]+/customConstraints/[^/]+$", "required": true, @@ -930,7 +930,7 @@ } } }, -"revision": "20251204", +"revision": "20260226", "rootUrl": "https://orgpolicy.googleapis.com/", "schemas": { "GoogleCloudOrgpolicyV2AlternatePolicySpec": { @@ -1205,7 +1205,7 @@ "type": "array" }, "name": { -"description": "Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 70 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/` is not counted.", +"description": "Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 71 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/custom.` is not counted.", "type": "string" }, "resourceTypes": { diff --git a/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json b/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json index a6243fa613..6e9a3931b3 100644 --- a/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json +++ b/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json @@ -586,7 +586,7 @@ } } }, -"revision": "20260202", +"revision": "20260301", "rootUrl": "https://paymentsresellersubscription.googleapis.com/", "schemas": { "Amount": { @@ -1377,7 +1377,7 @@ "type": "object" }, "Subscription": { -"description": "A subscription serves as a central billing entity between an external partner and Google. The underlying Google services rely on the subscription state to grant or revoke the user's service entitlement. It's important to note that the subscription state may not always perfectly align with the user's service entitlement. For example, some Google services may continue providing access to the user until the current billing cycle ends, even if the subscription has been immediately canceled. However, other services may not do the same. To fully understand the specific details, please consult the relevant contract or product policy.", +"description": "Acts as a central billing entity between an external partner and Google. Google services use the subscription state to grant or revoke the user's service entitlement. Note: The subscription state might not perfectly align with the user's service entitlement. Some services might continue providing access until the current cycle ends, even if the subscription is immediately canceled. Consult the relevant contract or product policy for specific details.", "id": "Subscription", "properties": { "cancellationDetails": { @@ -1819,7 +1819,7 @@ "type": "object" }, "UserSession": { -"description": "A user session contains a short-lived token that includes information required to interact with Google Payments Reseller Platform using the following web endpoints. - A user session token should be generated dynamically for an authenticated user. You should refrain from sharing a token directly with a user in an unauthenticated context, such as SMS, or email. - You can re-generate new session tokens repeatedly for same `generate` request if necessary, regardless of the previous tokens being expired or not. You don't need to worry about multiple sessions resulting in duplicate fulfillments as guaranteed by the same subscription id. Please refer to the [Google Managed Signup](/payments/reseller/subscription/reference/index/User.Signup.Integration/Google.Managed.Signup) documentation for additional integration details.", +"description": "Contains a short-lived token containing information required to interact with the Google Payments Reseller Platform via web endpoints. - Generate a user session token dynamically for an authenticated user. Do not share a token directly with a user in an unauthenticated context, such as SMS or email. - You can regenerate new session tokens repeatedly for the same `generate` request if necessary, regardless of whether previous tokens have expired. Multiple sessions will not result in duplicate fulfillments because the `subscription ID` guarantees uniqueness. For more integration details, see the [Google Managed Signup](/payments/reseller/subscription/reference/index/User.Signup.Integration/Google.Managed.Signup) documentation.", "id": "UserSession", "properties": { "expireTime": { diff --git a/googleapiclient/discovery_cache/documents/policysimulator.v1.json b/googleapiclient/discovery_cache/documents/policysimulator.v1.json index bc251fa4c4..60a621c15a 100644 --- a/googleapiclient/discovery_cache/documents/policysimulator.v1.json +++ b/googleapiclient/discovery_cache/documents/policysimulator.v1.json @@ -1061,7 +1061,7 @@ } } }, -"revision": "20251127", +"revision": "20260227", "rootUrl": "https://policysimulator.googleapis.com/", "schemas": { "GoogleCloudOrgpolicyV2AlternatePolicySpec": { @@ -1133,7 +1133,7 @@ "type": "array" }, "name": { -"description": "Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 70 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/` is not counted.", +"description": "Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 71 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/custom.` is not counted.", "type": "string" }, "resourceTypes": { diff --git a/googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json b/googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json index 08f7d60c07..60b2c40070 100644 --- a/googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json @@ -640,7 +640,7 @@ } } }, -"revision": "20251127", +"revision": "20260227", "rootUrl": "https://policysimulator.googleapis.com/", "schemas": { "GoogleCloudOrgpolicyV2AlternatePolicySpec": { @@ -712,7 +712,7 @@ "type": "array" }, "name": { -"description": "Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 70 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/` is not counted.", +"description": "Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 71 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/custom.` is not counted.", "type": "string" }, "resourceTypes": { diff --git a/googleapiclient/discovery_cache/documents/policysimulator.v1beta.json b/googleapiclient/discovery_cache/documents/policysimulator.v1beta.json index b1e86d1463..dc55de6f92 100644 --- a/googleapiclient/discovery_cache/documents/policysimulator.v1beta.json +++ b/googleapiclient/discovery_cache/documents/policysimulator.v1beta.json @@ -1197,7 +1197,7 @@ } } }, -"revision": "20251127", +"revision": "20260227", "rootUrl": "https://policysimulator.googleapis.com/", "schemas": { "GoogleCloudOrgpolicyV2AlternatePolicySpec": { @@ -1269,7 +1269,7 @@ "type": "array" }, "name": { -"description": "Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 70 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/` is not counted.", +"description": "Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 71 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/custom.` is not counted.", "type": "string" }, "resourceTypes": { diff --git a/googleapiclient/discovery_cache/documents/pubsub.v1.json b/googleapiclient/discovery_cache/documents/pubsub.v1.json index 55f38ef109..75859aac32 100644 --- a/googleapiclient/discovery_cache/documents/pubsub.v1.json +++ b/googleapiclient/discovery_cache/documents/pubsub.v1.json @@ -1798,7 +1798,7 @@ } } }, -"revision": "20260116", +"revision": "20260227", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AIInference": { @@ -1810,7 +1810,7 @@ "type": "string" }, "serviceAccountEmail": { -"description": "Optional. The service account to use to make prediction requests against endpoints. The resource creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent]({$universe.dns_names.final_documentation_domain}/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.", +"description": "Optional. The service account to use to make prediction requests against endpoints. The resource creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.", "type": "string" }, "unstructuredInference": { diff --git a/googleapiclient/discovery_cache/documents/run.v1.json b/googleapiclient/discovery_cache/documents/run.v1.json index f9d1a6d137..114c3062d2 100644 --- a/googleapiclient/discovery_cache/documents/run.v1.json +++ b/googleapiclient/discovery_cache/documents/run.v1.json @@ -3583,7 +3583,7 @@ } } }, -"revision": "20260220", +"revision": "20260227", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { @@ -4919,14 +4919,16 @@ false "SHA256", "MD5", "GO_MODULE_H1", -"SHA512" +"SHA512", +"DIRSUM_SHA256" ], "enumDescriptions": [ "No hash requested.", "Use a sha256 hash.", "Use a md5 hash.", "Dirhash of a Go module's source code which is then hex-encoded.", -"Use a sha512 hash." +"Use a sha512 hash.", +"Use a dirsum_sha256 hash." ], "type": "string" }, @@ -5327,14 +5329,16 @@ false "SHA256", "MD5", "GO_MODULE_H1", -"SHA512" +"SHA512", +"DIRSUM_SHA256" ], "enumDescriptions": [ "No hash requested.", "Use a sha256 hash.", "Use a md5 hash.", "Dirhash of a Go module's source code which is then hex-encoded.", -"Use a sha512 hash." +"Use a sha512 hash.", +"Use a dirsum_sha256 hash." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/run.v2.json b/googleapiclient/discovery_cache/documents/run.v2.json index 306e11cbf0..d0aaf41b51 100644 --- a/googleapiclient/discovery_cache/documents/run.v2.json +++ b/googleapiclient/discovery_cache/documents/run.v2.json @@ -2473,7 +2473,7 @@ } } }, -"revision": "20260220", +"revision": "20260227", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { @@ -6407,14 +6407,16 @@ false "SHA256", "MD5", "GO_MODULE_H1", -"SHA512" +"SHA512", +"DIRSUM_SHA256" ], "enumDescriptions": [ "No hash requested.", "Use a sha256 hash.", "Use a md5 hash.", "Dirhash of a Go module's source code which is then hex-encoded.", -"Use a sha512 hash." +"Use a sha512 hash.", +"Use a dirsum_sha256 hash." ], "type": "string" }, @@ -6815,14 +6817,16 @@ false "SHA256", "MD5", "GO_MODULE_H1", -"SHA512" +"SHA512", +"DIRSUM_SHA256" ], "enumDescriptions": [ "No hash requested.", "Use a sha256 hash.", "Use a md5 hash.", "Dirhash of a Go module's source code which is then hex-encoded.", -"Use a sha512 hash." +"Use a sha512 hash.", +"Use a dirsum_sha256 hash." ], "type": "string" },